Create and Publish API in the Catalog
In this section, you will find information about API creation and publication in the Catalog.
To register an API in the Catalog, access Service Catalog and follow the steps below:
Step 1. At the bottom of the screen, click on the 'Create' button and then on 'API';
Step 2. On the 'Basic Information' screen, fill out the 'Name' and 'Description' fields;
Step 3. Under 'API Definition', you must:
-
Upload a file with the OpenAPI standard (
.yaml,.ymlor.jsonextension, in versions 2.x, 3.0 and 3.1), already with the API contracts. -
Define one or more environments where you can publish the API.
-
Include the Gateway URL in each of the defined environments.
Then, click on 'Next';
Step 4. Review the API information and, if everything is correct, click 'Create API';
Step 5. Go to the created API screen and check if the contracts are correct. Then, click on the 'Publish API' button.
You have published an API in the Catalog.
To remove a published API, click 'Revert' and then 'Revert API'.
After you remove an API from the Catalog, you cannot publish it again. To post an API with the same content, you must create and publish it again.