Cloud-native API Administration with Red Hat 3scale API Management

You can create an ActiveDocs object either from the Audience page or from a product page. If you create the ActiveDocs from a product page then the ActiveDocs are assigned to that product.

To select any product for the OAS definition, create the ActiveDocs from the Audience page. For this you must navigate to Developer Portal>ActiveDocs, click Create a new spec, and complete the ActiveDocs form.

The 3scale Toolbox CLI has the activedocs command, which offers several subcommands to manage ActiveDocs objects.

[user@host ~]$ 3scale activedocs -h
NAME
    activedocs - activedocs super command

USAGE
    3scale activedocs <sub-command> [options]

DESCRIPTION
    Manage your ActiveDocs

SUBCOMMANDS
    apply      Update activedocs
    create     Create an ActiveDocs
    delete     Delete an ActiveDocs
    list       List ActiveDocs

All these subcommands affect ActiveDocs objects exclusively. For example, you can use the delete subcommand as a way to delete ActiveDocs objects.

[user@host ~]$ 3scale activedocs delete \
  REMOTE \ 
  ACTIVE_DOCS 

The 3scale Toolbox CLI offers a different way of creating ActiveDocs by importing the OAS definition. For this, you must use the import command and the openapi subcommand. You can get the OAS definition either from a file or from a URL.

This operation does more than creating the ActiveDocs object. It generates many 3scale API Management objects based on the OAS definition file. It creates:

This is an example command with some of the available options:

[user@host ~]$ 3scale import openapi \
  --target_system_name=SYSTEM_NAME \ 
  --destination=REMOTE \ 
  --default-credentials-userkey=ANONYMOUS_KEY 
  OAS_FILE 

After executing this command you must create an application plan and an application to make your API public.

To use the ActiveDocs interactive documentation you must add a CORS Request Handling policy and set the allow_origin to the Developer Portal domain. The reason for this is that the ActiveDocs request is sent from the Developer Portal domain, which is different from your API domain. When the domain from where the request is originated differs from the domain serving the request, the browser blocks the call unless you configure APIcast to allow it.