api-docs

Generate API documentation with HTTP methods, routes, parameters, and schemas.

105|8|Updated Feb 18, 2026
One-click install
npx skills add https://github.com/686f6c61/alfred-dev --skill api-docs-686f6c61
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-docs
Source: https://github.com/686f6c61/alfred-dev/tree/main/skills/documentacion/api-docs
Command: npx skills add https://github.com/686f6c61/alfred-dev --skill api-docs-686f6c61

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill addresses the critical need for clear, accurate, and up-to-date API documentation, preventing integration issues, bugs, and developer frustration.

Core Features & Use Cases

  • Endpoint Documentation: Details HTTP methods, routes, parameters, and request/response bodies.
  • Code Generation: Can output documentation in Markdown or OpenAPI (Swagger) formats.
  • Use Case: Documenting a new REST API for a microservice, ensuring frontend developers and external partners can easily understand and integrate with it.

Quick Start

Use the api-docs skill to document the GET /users/{id} endpoint with its parameters and example response.

Frequently Asked Questions about api-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate OpenAPI documentation for REST API endpoints?

Generate OpenAPI documentation for REST API endpoints by defining HTTP methods, routes, parameters, request bodies, and response schemas. This skill outputs machine-readable Swagger specifications and human-readable Markdown formats to maintain accurate API contracts.

What is the best way to document API request and response schemas?

The best way to document API request and response schemas is to detail the HTTP methods, routes, and parameters for each endpoint. This skill generates comprehensive documentation including request bodies and response schemas in Markdown or OpenAPI format.

Can I output API documentation in both Markdown and Swagger formats?

Yes, you can output API documentation in both Markdown and Swagger formats. This skill supports generating human-readable Markdown and machine-readable OpenAPI specifications to facilitate developer integration and maintain API contracts.

How do I document parameters and routes for a microservice REST API?

Document parameters and routes for a microservice REST API by specifying the HTTP methods, routes, and parameter types. This skill generates endpoint documentation covering all request and response details required for frontend developers and external partners.

Does this API documentation skill support generating example responses?

Yes, this API documentation skill supports generating example responses alongside HTTP methods, routes, and request bodies. It produces comprehensive endpoint documentation in OpenAPI or Markdown formats to prevent integration issues and developer frustration.

When do I need to use OpenAPI specifications for API documentation?

You need to use OpenAPI specifications for API documentation when maintaining machine-readable API contracts for developer integration. This skill generates OpenAPI and Markdown formats detailing HTTP methods, routes, parameters, and response schemas to ensure accurate microservice documentation.