Chapter 1. Add Your Spec To 3scale

Navigate to the API ActiveDocs tab in your Admin Portal. This will lead you to the list of your service specs (initially empty).

View larger image

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.

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

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.

View larger image

Once you’ve added your first API on ActiveDocs by adding a service spec, you can see it listed in the API ActiveDocs tab. You can edit it as necessary, delete it, or switch it from public to private.

View larger image

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:

View larger image