document_api
Skill3 starsChanged 2 months agoMITView on GitHub
Generates standardized API documentation (OpenAPI/Markdown) for backend endpoints.
1 other project uses a version of this, 1 of them edited.
Adopted by
Most recently taken up by
- krishnakanthb13/antigravity_global_skillsedited, first seen Jul 4, 2026
Other versions1 project uses a version of this.
Word for word · 0
None found.
Edited · 1
- krishnakanthb13/antigravity_global_skills★ 50100% same
Wrote their own version · 0
None found.
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 repository46 other files it gives its agents.
- agy-customizationsSkill
- antigravity-guideSkill
- api-and-interface-designSkill
- browser-testing-with-devtoolsSkill
- ci-cd-and-automationSkill
- code-review-and-qualitySkill
- code_reviewSkill
- code-simplificationSkill
- context-engineeringSkill
- create_launcherSkill
- create_skillSkill
- daily_logSkill
- debugging-and-error-recoverySkill
- debug_issueSkill
- deprecation-and-migrationSkill
- documentation-and-adrsSkill
- enhance_uiSkill
- frontend_designSkill
- frontend-ui-engineeringSkill
- generate_release_imageSkill
- git-workflow-and-versioningSkill
- idea-refineSkill
- idea_to_actionSkill
- impeccableSkill
- incremental-implementationSkill
- list_featuresSkill
- open_source_prepSkill
- optimize_codebaseSkill
- performance-optimizationSkill
- permissioned-githubSkill
- planning-and-task-breakdownSkill
- release_helperSkill
- repo_infographicSkill
- scaffold_testsSkill
- security-and-hardeningSkill
- security_auditSkill
- shipping-and-launchSkill
- software_architectureSkill
- spec-driven-developmentSkill
- test-driven-developmentSkill
- test_runnerSkill
- ui_ux_pro_maxSkill
- update_docsSkill
- using-agent-skillsSkill
- using-ui-stackSkill
- web_performance_optimizationSkill
The file
We split this skill into the rules it gives an agent
5 rules. About 0 are common, 2 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 8
Use this skill to automatically map out and document your server's API surface area.
- Very specific: line 17
Use grep_search to find route definitions (e.g., .get(, @app.route).
- Very specific: line 18
Use view_file to understand request/response schemas.
- Very specific: line 30
Format: Create/Update API_DOCUMENTATION.md (or generate an OpenAPI/Swagger spec).
- Distinctive: line 43
Ensure every identified route is listed.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 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
Document API
Use this skill to automatically map out and document your server's API surface area.
Inputs
- Source Code: The directory or entry point (e.g.,
server.js). - Format: Preferred output (Markdown vs Swagger/OpenAPI).
Tooling Strategy
- Use
grep_searchto find route definitions (e.g.,.get(,@app.route). - Use
view_fileto understand request/response schemas.
Workflow
1. Analysis
- Scan: Identify the server entry point (e.g.,
server.js,app.py). - Route Discovery: Trace route definitions (Express
.get(), Flask@app.route, FastAPI decorators). - Parameters: specific inputs (Body, Query Params, Path Variables).
2. Documentation Generation
- Format: Create/Update
API_DOCUMENTATION.md(or generate an OpenAPI/Swagger spec). - Structure:
- Endpoint Details:
METHOD /path, description, rate limiting limits, and Auth requirements. - Request Specification: Path/Query params, headers, and precise body schemas (with types & validation rules).
- Response Specification:
- 200 Success: Include a full JSON example.
- Error Responses: Document ALL possible error codes (e.g., 400 Bad Request, 401 Unauthorized, 409 Conflict), their message formats, and troubleshooting tips.
- Code Examples: Include a
cURLcommand example and a JavaScript/Python snippet if applicable. - Usage Guidelines: Provide a getting started guide, pagination patterns, and filtering/sorting options.
- Endpoint Details:
3. Output
- Make the documentation clear and consistent.
- Ensure every identified route is listed.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
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.