Chapter 1. Add Your Spec To 3scale
By the end of the section, you will have ActiveDocs set up for your API.
3scale offers a framework to create interactive documentation for your API.
With Swagger 2.0 (based on the Swagger Spec) you will have functional, attractive documentation for your API, which will help your developers to explore, to test and integrate with your API.
Every minute spent making your developers happy is a minute well invested on your API.
1.1. Step 1: Navigate to service specs in ActiveDocs
Navigate to [your_API_name] → ActiveDocs in your Admin Portal. This will lead you to the list of your service specs for your API (initially empty).
You can add as many service specs as you want. Typically, each service spec corresponds to one of your APIs. For instance, at 3scale we have four different specs, one for each API of 3scale: Service Management, Account Management, Analytics, and Billing.
1.2. Step 2: Create a service spec
When you add a new service spec, you will have to provide:
- Name
- System name (required to reference the Servcie Spec from the Developer Portal)
- Whether you want the spec to be public or not
- A description that is only meant for your own consumption
- API JSON spec, which you can see in the figure below.
The API JSON spec is the "secret ingredient" of ActiveDocs.
You must generate the specification of your API according to the spec proposed by Swagger. In this tutorial we assume that you already have a valid Swagger 2.0-compliant specification of your API.
1.3. Step 3: You got your first Swagger 2.0!
Once you’ve 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
You can also preview what your ActiveDocs looks like by clicking on the name you gave the service spec (in the example it was called it Pet Store). You can do this even if the spec is not public yet.
This is what your ActiveDoc will look like:
Where did the comment section go?
Red Hat's documentation publication system recently went through an upgrade to enable speedier, more mobile-friendly content. We decided to re-evaluate our commenting platform to ensure that it meets your expectations and serves as an optimal feedback mechanism. During this redesign, we invite your input on providing feedback on Red Hat documentation via the discussion platform.