FreeSkills
Commits, branches and sync with the but CLI
- 361361 downloads
- 198198 likes
- 103103 saves
Works with
- Claude Code
- Codex
- Cursor
- and 3 more
Clear API documentation with examples and errors v1.0.0
Use this resource to document a REST or GraphQL API from its code
New
- 584 downloads
- 173 likes
- 193 saves
Free
Install with the CLI
In a terminal, from the folder you want:
npx --yes palatekit@latest install api-reference-documentation-4With no option, the skill goes to ~/.agents/skills/; add --agent claude-code (or codex, cursor…) to target an agent.
First time: connect the CLI with
npx --yes palatekit@latest loginThe agent analyzes the API structure, writes the documentation for each endpoint, adds usage guidance and documents errors. It can also prepare an OpenAPI specification or a Postman collection.
Mostly picked by
Updated November 2, 2026
Previews
Details
- Install guides
- Generates with
- Your agent's model
- Licence
- MIT
Similar resources
View all- Free
FreeSkills
Sentry CLI guide
- 525525 downloads
- 117117 likes
- 128128 saves
Works with- Claude Code
- Codex
- Cursor
- and 3 more
FreeSkills
Drizzle ORM best practices with PostgreSQL
- 407407 downloads
- 194194 likes
- 151151 saves
Works with- Claude Code
- Codex
- Cursor
- and 3 more
FreeSkills
SLO design wizard
- 537537 downloads
- 105105 likes
- 242242 saves
Works with- Claude Code
- Codex
- Cursor
- and 3 more
FreeSkills
User stories and sprint fit
- 451451 downloads
- 150150 likes
- 132132 saves
Works with- Claude Code
- Codex
- Cursor
- and 3 more
FreeSkills
Capacity-based sprint plan
- 423423 downloads
- 192192 likes
- 102102 saves
Works with- Claude Code
- Codex
- Cursor
- and 3 more
FreeSkills
Startup CTO advisor
- 580580 downloads
- 201201 likes
- 242242 saves
Works with- Claude Code
- Codex
- Cursor
- and 3 more
FreeSkills
Creating GitHub pull requests with quality checks
- 427427 downloads
- 230230 likes
- 196196 saves
Works with- Claude Code
- Codex
- Cursor
- and 3 more
What you get
- sub-skills/openapiswagger.md: OpenAPI or Swagger specification
- sub-skills/postman-collection.md: Postman collection
- sub-skills/example-3-authentication-documentation.md: authentication documentation
Good fit for
- Your API has no documentation for external developers
- Existing documentation no longer matches the code
Not for
Tags
- api
- documentation
- openapi
- postman
About
You say
“Document the endpoints of my orders API, including authentication and errors, in OpenAPI format.”
Skill published by dokhacgiakhoa under the MIT license, delivered in its original version.
Show moreShow less
How to use it
- Install the skill in your agent's skills folder
- Ask your agent to document a REST or GraphQL API from its code
- Review and adjust the result
Content preview
Files
- LICENSE2.4 KB
- NOTICE-PALATEKIT.md0.5 KB
- SKILL.md2.6 KB
- sub-skills/do-this.md0.7 KB
- sub-skills/dont-do-this.md0.6 KB
- sub-skills/example-1-rest-api-endpoint-documentation.md2.2 KB
- sub-skills/example-2-graphql-api-documentation.md0.9 KB
- sub-skills/example-3-authentication-documentation.md0.1 KB
- sub-skills/getting-a-token.md0.3 KB
- sub-skills/openapiswagger.md0.3 KB
- sub-skills/postman-collection.md1.1 KB
- sub-skills/problem-documentation-gets-out-of-sync.md0.3 KB
- sub-skills/problem-examples-dont-work.md0.2 KB
- sub-skills/problem-missing-error-documentation.md0.3 KB
- sub-skills/problem-unclear-parameter-requirements.md0.3 KB
- sub-skills/recommended-sections.md0.9 KB
- sub-skills/step-1-analyze-the-api-structure.md0.3 KB
- sub-skills/step-2-generate-endpoint-documentation.md0.6 KB
- sub-skills/step-3-add-usage-guidelines.md0.2 KB
- sub-skills/step-4-document-error-handling.md0.2 KB
- sub-skills/step-5-create-interactive-examples.md0.2 KB
- sub-skills/token-expiration.md0.2 KB
- sub-skills/using-the-token.md0.1 KB
Origin and licence
Listed unmodified
- Author
- dokhacgiakhoa
- Source
- github.com/dokhacgiakhoa/agent-skills-4-vibe-coding-cli/tree/c4a059bbf7a8d6b2162071f0fbfe74053faa6d20/.agent/skills/api-documentation-generator
- Licence
- MIT
Notice
« api-documentation-generator » (dokhacgiakhoa, MIT) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.
User reviews
–
No ratings yet
Loading reviews…