skills.rest
codewizwit
codewizwitCOMMUNITY
Explore all skills by this author →
GitHub

api-documentation

Generates OpenAPI specifications and endpoint documentation from controllers, routes, and DTOs.

1|Updated Oct 11, 2025
Search Tags:#openapi#rest#graphql#swagger#api documentation#generate#endpoint reference
One-click install
npx skills add https://github.com/codewizwit/human-in-the-loop --skill api-documentation-codewizwit
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-documentation
Source: https://github.com/codewizwit/human-in-the-loop/tree/main/lib/skills/api-documentation
Command: npx skills add https://github.com/codewizwit/human-in-the-loop --skill api-documentation-codewizwit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing and maintaining API documentation by hand is slow and quickly drifts out of sync with the actual codebase. This Skill analyzes your controllers, routes, DTOs, and schemas to produce accurate OpenAPI specs, endpoint references, and developer guides directly from the source code. ## Core Features & Use Cases - Automatic Endpoint Discovery: Scans controllers, routes, resolvers, and DTOs to catalog every endpoint, including authentication requirements and error responses. - OpenAPI 3.0 Generation: Produces valid OpenAPI 3.0.3 specifications with component schemas derived from your DTOs and entities. - GraphQL Schema Docs: Documents GraphQL types, queries, and mutations with example queries and variables. - Use Case: You just shipped a new payments module in a NestJS backend. Ask the Skill to document it, and it discovers the new endpoints, maps request/response DTOs to schemas, and updates your existing OpenAPI spec without overwriting prior work. ## Quick Start Ask the AI to generate OpenAPI 3.0 documentation for all endpoints in your backend service.

Frequently Asked Questions about api-documentation

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

FAQPage Schema
How do I generate an OpenAPI spec from my existing code?▼

Point the Skill at your codebase and it discovers controllers, routes, and DTOs, then maps them to a valid OpenAPI 3.0.3 specification. It extracts HTTP methods, paths, parameters, request bodies, and response schemas automatically.

How to document a GraphQL API schema with examples?▼

The Skill analyzes GraphQL resolvers and type definitions to produce schema documentation with annotated types, query and mutation references, and example queries with variables. Authentication requirements are documented per operation.

Does it work with NestJS, Express, and Fastify projects?▼

Yes, it reads package.json to identify frameworks like Express, NestJS, Fastify, and Apollo, then applies the appropriate discovery patterns for controllers, routes, and resolvers in each framework.

Will it overwrite my existing API documentation?▼

No, the Skill locates existing OpenAPI specs and documentation during its discovery phase and preserves them when updating. It confirms with the user before overwriting any existing documentation files.

What happens to endpoints that lack documentation or types?▼

Undocumented endpoints are never skipped silently. The Skill flags them in its final summary along with documentation gaps and suggestions for improving coverage.

Related Skills

Explore More Software Engineering Skills→
pekralpekral

api-review

Analyzes HTTP API surface areas in code diffs for REST compliance and security.

Community
Advanced
dinoudondinoudon

api-documentation

Generates API references and SDK scaffolds from OpenAPI specifications.

Community
Advanced
gajjalaashok75-UIgajjalaashok75-UI
2

API-Atlas

Design, implement, document, and secure REST and GraphQL APIs.

Community
Advanced
thatsmethatsme
70

giulia

Analyze Elixir/OTP codebases with static analysis and runtime introspection.

Community
Advanced