Documenting Your API

It's important to make it as easy as possible for your API consumers to use your API. Rapid provide many ways to add general documentation related to your API. The table below provides an overview of the ways to document your API, as well as links to more information.

Notes:

• Descriptions and Long Descriptions are indexed and included in API search results.
• (Enterprise Hubs only) The following information can be imported or exported from OAS documents. The Description is stored in downloaded or uploaded OAS documents as info.description. The Long Description is stored in downloaded or uploaded OAS documents as info.x-long-description. Readme / Docs is stored as x-documentation.readme. Titles, descriptions, and links for Tutorials and Spotlight are stored in x-documentation.tutorials and x-documentation.spotlights, respectively. For more information, see Adding and Updating OpenAPI Documents.
• (Enterpise Hubs only) You can programmatically read and manage this information using the GraphQL Platform API. For more information, see API Documentation (GQL PAPI).