What is API Document in APIGit

API Documents in APIGit leverage OpenAPI spec files and markdown files from your API Repository to build comprehensive and beautiful multi-versioned documentation sites. API documents include two major components:

• API Spec: Your API specifications are rendered in our interactive OpenAPI viewer to create beautiful, easily navigable presentations of your API definitions.
• Markdown: Markdown files provide an excellent way to introduce business logic or additional guidelines that complement your technical API documentation.

Together, these components create a comprehensive documentation site. You can review them directly in the API Repository or publish and share them with your team or partners.

In the following sections, we’ll introduce each component in detail.