Create API in an Application

In this section, you will learn how to create an API in Workspace and publish it in the Service Catalog.

To create an API from an Application, follow the steps below:

Step 1. Go to your Workspace Dashboard in StackSpot Portal;

Step 2. From the Application Dashboard, click the 'Create' button at the bottom left of the screen. Then, click on 'Application';

Choose a Stack and a Starter.

Step 4. On the 'Applications Information screen, fill out the fields:

• Name.
• Add a short description.

Then, click on the 'Next Step' button;

Step 5. At the 'Source Code Repository' screen, select one of the options:

• Create repository: in this option, you also need to choose the visibility your Application will have.
• I already have a repository: enter the URL of the repository you want to use.

Then click on 'Continue';

Step 6. Under 'API Definition', you need to:

• Upload a file with the OpenAPI standard (.yaml, .yml or .json extension).
• Name and describe the API.
• Add a Swagger with one or more available environments. Include the Gateway URL for each.

You can define this after you create the API. To do this, access the Configuration section of the application you created.

To continue, click on 'Continue';

Step 7. Review the settings summary. If everything is correct, click 'Commit'.

Publish an API to the Catalog:

Follow the instructions below:

1. Access the 'API' subsection;
2. Click on the API you have created;
3. Then click on 'Publish API'.

You have published an API to the Catalog.

To remove a published API, click on 'Unpublish' and then 'Unpublish API'.

Learn more

• FAQ