api-documentation-generator
Generate comprehensive, developer-friendly API documentation from code
by sickn33Free
Description
api-documentation-generator is an agent skill that generates clear, developer-friendly API documentation from a codebase. The documentation covers endpoints, parameters, request and response examples, authentication details, error handling and usage guidelines. It is for REST, GraphQL and WebSocket APIs. Use it when you need to document a new API, update existing documentation, document an API that has none, onboard new developers, prepare documentation for external users, or create an OpenAPI or Swagger specification. The skill works by reading the code to find the endpoints and their parameters, and then writing documentation that a developer can follow, with examples. Use it as a starting point for documentation that a person then reviews against the real behaviour of the API. It is part of the sickn33/agentic-awesome-skills repository on GitHub, which has about 47,600 stars. The listing shows it as free, and it has about 2,200 installs. Its security audits show passes from Gen Agent Trust Hub, Socket and Snyk. Install it with npx skills add https://github.com/sickn33/agentic-awesome-skills --skill api-documentation-generator.…
Highlights
- Endpoints, parameters and examples
- Authentication and error handling docs
- REST, GraphQL and WebSocket APIs
- OpenAPI or Swagger specifications
- Generated from the codebase
Ratings & Reviews
No ratings yet
Be the first to rate api-documentation-generator.
People also visit
api-documentation-generator FAQ
What does it generate?
API documentation with endpoints, parameters, request and response examples, authentication, errors and usage guidelines.
Which API styles?
REST, GraphQL and WebSocket APIs.
Can it produce OpenAPI?
Yes. The skill lists creating OpenAPI or Swagger specifications as a use case.
Should the output be checked?
Yes. It is a starting point to be reviewed against the real behaviour of the API.
How do I install it?
Run npx skills add https://github.com/sickn33/agentic-awesome-skills --skill api-documentation-generator.
Is it checked for security?
Its security audits show passes from Gen Agent Trust Hub, Socket and Snyk.
What are the best api-documentation-generator alternatives?
Popular alternatives to api-documentation-generator include aspnet-minimal-api-openapi, api-designer and golang-swagger. See all api-documentation-generator alternatives