Chapter 3. Adding ActiveDocs to 3scale

Procedure

1. Navigate to [your_API_name] ActiveDocs in your Admin Portal. 3scale displays the list of your service specifications for your API. This is initially empty.

   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.

2. Click Create a new spec.

   When you add a new service specification, provide the following:

   • Name
   • System name. This is required to reference the service specification from the Developer Portal.

   • Choose whether you want the specification to be published or not. If you do not publish, the new specification will not be available in the Developer Portal.

     Note

     If you create, but do not publish your new specification, it will remain available to you for publication at a later time of your choosing.

   • Add a description that is meant for only your consumption.

   • Add the API JSON specification.

     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.