GET /api/apis/versions/{APIVersionID}/swagger

Returns the automatically-generated Swagger version 1.1 resource document for the specified API version, showing the path to each resource.

This operation automatically generates an inventory of all operations for the specified API version, and stores it in a Swagger file of the format specified in the parameters.

Additional information:

Authorization Roles/Permissions: Must have Read permission for the resource.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/apis/versions/{APIVersionID}/swagger

Sample Request

The example below shows a request for the Swagger document in JSON format.

Sample Request URL 

https://{hostname}/api/apis/versions/apiversion11155.acmepaymentscorp/swagger.json

Sample request headers 

GET /api/apis/versions/apiversion11155.acmepaymentscorp/swagger.json HTTP/1.1
Host: {hostname}
Accept: application/json, text/javascript, */*; q=0.01
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
Cookie AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter Parm Type Data Type Required Description
APIVersionID Path string Required The unique ID for a specific API version.
locale Query string Optional The locale applicable to the user requesting the content. For more information, see Supporting Multiple Languages.

Response

If successful, this operation returns HTTP status code 200, with information about the Swagger document in JSON format.

Sample Response

The sample response below shows Swagger information returned for the specified API, version 1.0.

Sample response headers: application/json 

HTTP/1.1 200 OK
Date: Wed, 13 Feb 2013 20:25:09 GMT
Content-Type: application/json

Sample response body: application/json 

{
  "apiVersion" : "1.0",
  "apis" : [ {
    "path" : "/legal.{format}"
  }, {
    "path" : "/trends.{format}"
  }, {
    "path" : "/oauth.{format}"
  }, {
    "path" : "/users.{format}"
  }, {
    "path" : "/direct_messages.{format}"
  }, {
    "path" : "/saved_searches.{format}"
  }, {
    "path" : "/geo.{format}"
  }, {
    "path" : "/blocks.{format}"
  }, {
    "path" : "/favorites.{format}"
  }, {
    "path" : "/statuses.{format}"
  }, {
    "path" : "/help.{format}"
  }, {
    "path" : "/followers.{format}"
  }, {
    "path" : "/friends.{format}"
  }, {
    "path" : "/search.{format}"
  }, {
    "path" : "/notifications.{format}"
  }, {
    "path" : "/friendships.{format}"
  }, {
    "path" : "/account.{format}"
  }, {
    "path" : "/report_spam.{format}"
  }, {
    "path" : "/lists.{format}"
  } ],
  "basePath" : "https://{hostname}/api/apis/versions/apiversion11155.acmepaymentscorp",
  "swaggerVersion" : "1.1"
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Response Body

Name Type Description
Swagger resource document String A document containing automatically-generated content about the API.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.