api-documentation

Developer Tools

Gives your agent the ability to create comprehensive, interactive, and developer-friendly API documentation using OpenAPI and Swagger standards.

When to use

When you need to generate a formal OpenAPI (Swagger) specification
When you want to add interactive docs like Swagger UI to your project
When you need clear API reference guides with real code examples

How to use

1
Specify the API endpoints, request bodies, and success/error responses
2
Generate a YAML or JSON OpenAPI 3.0 specification file
3
Add JSDoc or decorator comments to your source code for auto-generation
4
Organize the docs into READMEs, getting-started guides, and reference sections

Example conversation

case

You

I need to document our new user authentication API so our frontend team can start integrating it.

Agent

I'll create a complete OpenAPI spec for your auth endpoints. I'll include 'POST /v1/auth/login' with a clear request body schema and examples of both success (200 OK with JWT) and failure (401 Unauthorized) cases. I'll also provide a 'Getting Started' guide with curl examples so your team can test the API immediately using Swagger UI.

FAQ

Related Skills

documentation-writerContent & Writing

Gives your agent the ability to create expert-level technical documentation structured according to the Diátaxis framework's four quadrants.

create-oo-component-documentationDeveloper Tools

Gives your agent the ability to generate comprehensive, standardized technical documentation for object-oriented components, complete with architecture diagrams and API references.

update-oo-component-documentationContent & Writing

Gives your agent the ability to update object-oriented component documentation by analyzing source code and implementation patterns.

api-designDeveloper Tools

Gives your agent the ability to design high-quality RESTful and GraphQL APIs following industry best practices and OpenAPI standards.

typespec-api-operationsDeveloper Tools

Gives your agent the ability to add RESTful operations like GET, POST, and DELETE to TypeSpec API plugins with Adaptive Cards.

api-documentation

Developer Tools

Gives your agent the ability to create comprehensive, interactive, and developer-friendly API documentation using OpenAPI and Swagger standards.

When to use

When you need to generate a formal OpenAPI (Swagger) specification
When you want to add interactive docs like Swagger UI to your project
When you need clear API reference guides with real code examples

How to use

1
Specify the API endpoints, request bodies, and success/error responses
2
Generate a YAML or JSON OpenAPI 3.0 specification file
3
Add JSDoc or decorator comments to your source code for auto-generation
4
Organize the docs into READMEs, getting-started guides, and reference sections

Example conversation

case

You

I need to document our new user authentication API so our frontend team can start integrating it.

Agent

FAQ

Related Skills

documentation-writerContent & Writing

Gives your agent the ability to create expert-level technical documentation structured according to the Diátaxis framework's four quadrants.

create-oo-component-documentationDeveloper Tools

Gives your agent the ability to generate comprehensive, standardized technical documentation for object-oriented components, complete with architecture diagrams and API references.

update-oo-component-documentationContent & Writing

Gives your agent the ability to update object-oriented component documentation by analyzing source code and implementation patterns.

api-designDeveloper Tools

Gives your agent the ability to design high-quality RESTful and GraphQL APIs following industry best practices and OpenAPI standards.

typespec-api-operationsDeveloper Tools

Gives your agent the ability to add RESTful operations like GET, POST, and DELETE to TypeSpec API plugins with Adaptive Cards.

Product

Community

api-documentation

When to use

How to use

Example conversation

FAQ

Related Skills

Product

Community

api-documentation

When to use

How to use

Example conversation

FAQ

Related Skills

Product

Community