As part of the 3scale API management platform, you'll have the ability to create interactive documentation of your API using a feature called Active Docs. Based on the Swagger project, Active Docs allows developers to construct and test calls and preview a sample response.
Creating docs for your API is as easy as following the Swagger specification – plus, 3scale's team has added some extra features, like auto-filling API keys for signed-in users.
Curious? Complete the signup form below and log in to your account, then check out 3scale's API documentation.
To see more of Active Docs, as well as the many other features 3scale's API management platform provides, please create an account.
You'll get an email with your account login details as well as a verification link in the next few minutes.
If you'd prefer to schedule a product demo, please click here.
Using Active Docs for your API documentation allows developers to make live API calls and see the response directly from your documentation page before they begin writing code.
This example Service Spec is taken from 3scale's API documentation. Required and optional parameters for this method are indicated; the sample below shows the expected response to the test request.
Interactive API documentation makes it easier for developers to test before they build
Use additional Swagger features and tools, like a code generator for creating client-side libraries for your API
Active Docs is a built-in feature of the developer portal CMS within your 3scale account