tomevault-io API Documentation Skill
Purpose
Create clear, accurate, and comprehensive API documentation.
Documentation Components
1. Overview
- API purpose and capabilities
- Authentication requirements
- Base URL and versioning
- Rate limits and quotas
2. Endpoint Documentation
- HTTP method and path
- Request parameters (path, query, body)
- Request/response examples
- Error responses and codes
- Authentication requirements
3. Code Examples
- Multiple language examples (curl, JavaScript, Python)
- Complete, runnable snippets
- Common use case scenarios
Best Practices
- Be Accurate - Documentation must match actual behavior
- Use Examples - Real request/response pairs
- Explain Errors - Document all error codes and recovery steps
- Version Clearly - Note API version and deprecations
- Keep Updated - Update docs with every API change
Format Standards
- OpenAPI/Swagger for REST APIs
- GraphQL schema for GraphQL APIs
- JSDoc/TSDoc for library functions
Converted and distributed by TomeVault — claim your Tome and manage your conversions.