Interactive documentation support helps users to understand and experience the APIs better. WSO2 API Manager provides this functionality through the integration of Swagger (https://developers.helloreverb.com/swagger). Swagger is a specification and a complete framework implementation for describing, producing, consuming, and visualizing RESTful Web services. You can load APIs that are described in simple, static JSON representation through the Swagger UI and and make them available as interactive documentation.
The idea of this interactive console is allowing users to test the APIs and get to know how they respond without subscribing to the APIs. When an API is created in API Publisher, the JSON representation of that API is automatically generated and saved into the registry as an API definition. This API definition describes the API using the information provided at the time it is created. You can modify the API definition using the Doc tab in the management console. In API Store, the Swagger UI discovers the API definition for each API and displays the interactive documentation in the API's Documentation tab.
The sections below explain how to create an interactive documentation for an API:
Enabling cross-origin resource sharing
Swagger-based interactive documentation allows you to try out APIs from the documentation itself. It is a Java Script client that runs in the API Store and makes Java Script calls from the Store to the API Gateway. Since the API Store and Gateway run on two different ports, you must enable cross-origin resource sharing (CORS) between the two using CORS configuration in
<APIM_HOME>/repository/conf/api-manager.xml file. Given below is a sample configuration of CORS and a description of its XML elements:
|<Enabled>||True/False||Used to enable/disable sending CORS headers from the Gateway. By default, CORS is enabled (True). This is needed for Swagger to function properly.|
|<Access-Control-Allow-Origin>||HTTP and HTTPS Store Address. Change the Host and Port for correct values of your store. For example, ||The value of the |
Header values you need to pass when invoking the API. For example,
|Default values are sufficient for Swagger to function.|
|<Access-Control-Allow-Methods>||GET, POST, PUT, DELETE, OPTIONS||Methods required to be supported from the Swagger client.|
Creating an API
- Log in to API Publisher Web interface (https://localhost:9443/publisher), and go to Add API page. Create a new API with following information by navigating to each tab.
- Name: PhoneVerification
- Context: /phoneverify
- Version: 1.0.0
- Choose to create a wildcard resource (/*)
- Endpoint type: HTTP
- Production Endpoint: http://ws.cdyne.com/phoneverify/phoneverify.asmx
- Tier availability: Bronze/Gold/Silver/Unlimited
- Transports: HTTP/HTTPS
In the Manage screen, you can specify an authentication type for the methods of the resource that you created earlier.
For each of the resource that has HTTP verbs requiring Authentication (i.e., Auth Type is not NONE), enable OPTIONS with None Auth type. For example, as the following screen shot shows, resources with /* URL Pattern has HTTP verbs with Auth Type as
Application & Application User. Therefore, we must give None as the Auth Type of OPTIONS. This is to support CORS (Cross Origin Resource Sharing) between the API Store and Gateway. But, if no authentication is needed for any of the HTTP verbs, you don't have to specify None Auth type to OPTIONS.
Publish the API to the API Store.
Updating the API definition
The API creator can update/customize the automatically generated API definition for each API.
Log in to the API Publisher, go to the Doc tab of
PhoneVerifyAPI and click Edit Content under Swagger Documentation.
The API definition opens. Note that the API definition contains its JSON representation.
- By default, all the POST and PUT operations have a
Payloadparameter, which you can use to send any payload when invoking the API.
- You can use the
Query parametersin GET, DELETE operations to send URL-appended values (e.g.,: v=2&length=200).
- By default, all the POST and PUT operations have a
Modify existing content, add/remove elements, change paths and parameters of the API definition using either of the following editors: Text Editor or the Graphical Tree Editor.
- API Manager 1.5.0 onwards has integrated JSONMate as the editor for modifying the API Definition.
- For the Swagger specification of API declaration, see
The example below shows how we have changed the path for all the HTTP methods of the API definition from
/phoneverify/1.0.0/CheckPhoneNumberusing both the text editor and graphical tree editor:
After the modifications are done, click save.
The Swagger JSON files are saved in the following location in the registry:
/_system/governance/apimgt/applicationdata/api-docs/<API name>/api-doc.json. To browse the registry, log in to the management console (https://localhost:9443/carbon) as admin/admin and select Resources -> Browse menu.
Invoking the interactive documentation
- Log in to the API Store Web interface (https://localhost:9443/store) and click the API published before.
- Subscribe to the API using the Bronze tier.
- Generate access tokens. You need them to invoke the API in the next steps.
Select the API again and go to the API Console tab, which shows the interactive documentation of the API.
Provide the necessary parameters and click Try it out to call the API. For example, the
PhoneVerificationAPI takes two parameters: the phone number and a license key, which is set to 0 for testing purposes.
Note the following in the above UI:
Base URL Appears at the bottom of the console. Using the base URL and the parameters, the system creates the API URL in the form
http://host:8280/<context>/<version>/<back end service requirements included as parameters>.For example,
Query Parameters Give the API payload as PhoneNumber=18006785432&LicenseKey=0 where /phoneverify is the context and 1.1.0 is the version. The rest of the URL is driven by the backend service requirements. Authorization In the authorization header, pass the application key that was generated at the time a user subscribes to an API. This is prefixed by the string "Bearer". For example, Bearer q6- JeSXxZDDzBnccK3ZZGf5_AZTk.
WSO2 API Manager enforces OAuth security on all the published APIs. Consumers who talk to the API Manager should send their credentials (application key) as per the OAuth bearer token profile. If you don't send an application key or send a wrong key, you will receive a 401 Unauthorized response in return.
- Note the response for the API invocation that appears as follows:
- Within a minute after the first API invocation, make another attempt to invoke the API and note that the second invocation results in a throttling error.
This is because you applied a Bronze tier at the time you subscribed to the API and the Bronze tier only allows one API call per minute.