Agent skill
api-documentation
Document each endpoint with: HTTP method and path, description, request parameters (path, query, ... Use when documenting code and APIs. Documentation category skill.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/other/api-documentation
Metadata
Additional technical details for this skill
- category
- Documentation
- priority
- medium
- is built in
- YES
- session guardian id
- builtin_api_docs
SKILL.md
API Documentation
Document each endpoint with: HTTP method and path, description, request parameters (path, query, body) with types, response format with examples, error codes and their meanings, authentication requirements. Use OpenAPI/Swagger for REST APIs. Include runnable examples. Document rate limits and pagination. Keep docs in sync with code—consider generating from annotations or types.
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
majiayu000/claude-skill-registry
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
majiayu000/claude-skill-registry
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
majiayu000/claude-skill-registry
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?