Chapter 3. Adding specifications to 3scale

Navigate to [your_API_name] ActiveDocs in your Admin Portal. This will lead you to the list of your service specifications for your API (initially empty).

View larger image

You can add as many service specifications as you want. Typically, each service specification corresponds to one of your APIs. For example, 3scale has specifications for each 3scale API, such as Service Management, Account Management, Analytics, and Billing.

When you add a new service spec, you will have to provide:

The API JSON specification is the "secret ingredient" of ActiveDocs.

You must generate the specification of your API according to the specification proposed by OpenAPI Specification (OAS). In this tutorial we assume that you already have a valid OAS-compliant specification of your API.

View larger image

Once you have added your first ActiveDoc, you can see it listed in [your_API_name] ActiveDocs. You can edit it as necessary, delete it, or switch it from public to private. You can also detach it from your API or attach it to any other API. You can see all your ActiveDocs (attached to an API or not) in Audience Developer Portal ActiveDocs

View larger image

You can also preview what your ActiveDocs looks like by clicking on the name you gave the service specification (in the example it was called it Pet Store). You can do this even if the specification is not public yet.

This is what your ActiveDoc will look like:

View larger image