Create and Publish API
In this section, you will learn how to create and publish an API.
Create API
To register an API in the Catalog, access the Service Catalog and follow the steps below:
Step 1. At the bottom of the screen, click the 'Create' button, then select 'API'.
Step 2. On the 'Basic Information' screen, fill in the 'Name' and 'Description' fields.
Step 3. Under 'API Definition', you must:
- Upload a file in the OpenAPI standard (
.yaml,.yml, or.jsonextensions, versions 2.x, 3.0, or 3.1), already containing the API contracts. - Define one or more environments in which the API will be published.
- Include the Gateway URL for each defined environment.
Then, click 'Next'.
Step 4. Review the API information and, if everything is correct, click 'Create API'.
Publish API
Step 5. Go to the created API's screen and verify that the contracts are correct. Then, click the 'Publish API' button.
Your API is now published in the Catalog.
To remove a published API, click 'Revert' and then 'Revert API'.
Once an API has been removed from the Catalog, it cannot be published again. To publish an API with the same content, you must create and publish it again.
Edit API
Editing rules:
- Name: Cannot be changed.
- Description: Cannot be changed.
- OpenAPI File: Can be changed.
- Connection Interface: If not specified during API registration, this field will be blank. In this case, you can edit and select a Connection Interface. If a Connection Interface was already specified during registration, this field cannot be edited.
- Gateway URL: Can be changed.
If you select an environment while creating the API, edits will apply only to that environment.
Follow these steps to edit an API:
Step 1. Access the 'Settings' section of your API.
Step 2. In 'API Information', click the edit icon.
Step 3. If necessary, edit the following fields:
- OpenAPI File
- Connection Interface
- Gateway URL
Step 4. Click 'Save'.
You have successfully edited an API.