API Documentation

This page demonstrates how to use the swagger-ui-tag plugin to render OpenAPI specifications.

Internal API

Our internal API provides endpoints for managing users, projects, and other resources.

openapi: ../api/openapi.yaml

Using API Documentation

The API documentation above is interactive. You can:

1. Try out API endpoints directly from this page
2. View request/response examples
3. Expand schema definitions to see all fields
4. Switch between production and staging servers

Implementation Notes

To include API documentation like this in your documentation:

1. Create an OpenAPI specification file (YAML or JSON)
2. Reference it in your Markdown using the swagger-ui codeblock:

```swagger-ui
openapi: path/to/your/openapi.yaml

The plugin supports various options:

• openapi: Path to your OpenAPI specification
• layout: Controls the layout (can be "BaseLayout" or "StandaloneLayout")

For more details, see the swagger-ui-tag documentation.