generate-api-docs
Skill0 starsChanged 9 months agoMITView on GitHub
Create comprehensive API documentation for the current endpoints formatted as OpenAPI/Swagge...; keywords: api, openapi, swagger, error. Use only on explicit request; skip in routine implementation discussions.
We split this skill into the rules it gives an agent
1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 10
Create comprehensive API documentation for the current endpoints formatted as OpenAPI/Swagger specification or following the project's …
≈ “Common” is an estimate: at least 1 in 5 of the 308,232 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Generate API Documentation
Overview
Create comprehensive API documentation for the current endpoints formatted as OpenAPI/Swagger specification or following the project's documentation standards.
Steps
- API Overview
- Service description and purpose
- Base URL and versioning information
- Authentication and authorization requirements
- Rate limiting and usage policies
- Endpoint Documentation
- HTTP method and URL path
- Request parameters (path, query, body)
- Request/response schemas with data types
- Example requests and responses
- Possible error codes and messages
- Data Models
- Define all data models and schemas
- Include field descriptions and constraints
- Show relationships between models
- Provide example payloads
- Usage Examples
- Common use case scenarios
- SDK and client library examples
- CURL command examples
- Error handling examples
API Documentation Checklist
- API overview complete
- Endpoints documented
- Data models defined
- Usage examples provided
- Documentation formatted per project standards
Other versions2 projects use a version of this.
Word for word · 0
None found.
Edited · 1
- emaraschio/cursor-commands★ 977% same
Wrote their own version · 1
- cachewraith/cachewraith-skills★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository31 other files it gives its agents.
- accessibility-auditSkill
- add-documentationSkill
- add-error-handlingSkill
- address-github-pr-commentsSkill
- clarify-taskSkill
- code-reviewSkill
- create-prSkill
- database-migrationSkill
- debug-issueSkill
- deslopSkill
- diagramsSkill
- docker-logsSkill
- fix-compile-errorsSkill
- fix-git-issuesSkill
- generate-pr-descriptionSkill
- git-commitSkill
- git-pushSkill
- light-review-existing-diffsSkill
- lint-fixSkill
- lint-suiteSkill
- onboard-new-developerSkill
- optimize-performanceSkill
- overviewSkill
- refactor-codeSkill
- roadmapSkill
- run-all-tests-and-fixSkill
- security-auditSkill
- security-reviewSkill
- setup-new-featureSkill
- visualizeSkill
- write-unit-testsSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.