api-docs-icon

API Projects

In Sideko, an API Project is a centralized place for managing the OpenAPI specifications of your APIs. Each API server maps one-to-one with an API Project, and you can upload multiple versions of the OpenAPI specifications as your API evolves.

Creating an API Project

To start managing your API with Sideko, you need to create an API Project. This can be done through the following methods:

  • Sideko UI
  • Sideko REST API using an API key or service account key
  • Sideko CLI using an API key or service account key

Uploading an OpenAPI Specification

Once your API Project is created, the next step is to upload your OpenAPI Specification. This initial upload represents the first version of your API within the project.

Uploading New Versions of the OpenAPI Specification

As your API changes, you will need to upload new versions of the OpenAPI Specification. Each new upload is considered a new API Project Version.

By following these steps, you can effectively manage and version your API specifications within Sideko, ensuring your documentation, SDK generation, testing, and publishing capabilities are always up-to-date with the latest changes in your API.