Generate structured Markdown API documentation from predefined templates.
npx skills add https://github.com/hokix/dotfiles --skill doc-api-md
Please help me install this Agent Skill. Skill: doc-api-md Source: https://github.com/hokix/dotfiles/tree/main/ai/.agents/skills/doc-api-md Command: npx skills add https://github.com/hokix/dotfiles --skill doc-api-md
This Skill streamlines the creation of API documentation by providing standardized Markdown templates for both client-facing (toC) and server-to-server APIs.
Use the doc-api-md skill to generate documentation for a new toC API endpoint.
High-intent search queries and answers about installing and using this skill.
To generate API documentation in Markdown, you provide endpoint details, schemas, and authentication info to produce structured documents using predefined templates for domains and contacts.
Documenting a REST API for both mobile and server interfaces is handled by generating standardized Markdown using separate predefined templates specifically designed for toC and server-to-server APIs.
You can define request and response schemas when creating an API specification, as the generation process structures domains, endpoints, authentication, and contact information into the Markdown output.
This Markdown generator supports different templates for toC and server APIs, utilizing specific assets like toc_template.md and server_template.md to ensure structured output for each interface type.
To generate a structured REST API document, you need to provide endpoint details, domain definitions, request and response schemas, authentication methods, and contact information for the template processing.
OneWave-AIGenerate OpenAPI/Swagger specs and endpoint documentation for REST, GraphQL, WebSocket, and gRPC APIs.
JongsixGenerate technical documentation from source code and API definitions.
vladm3105Validate API contracts and detect breaking changes across OpenAPI/AsyncAPI specifications.
asd335w3dGenerate Markdown API documentation from backend code or OpenAPI specifications.
