Api Documentation

---
name: api-documentation
description: "Use when documenting APIs."
version: 1.0.0
author: Hermes Agent
license: MIT
platforms: [linux, macos, windows]
metadata:
  hermes:
    tags: [api, documentation, openapi, swagger]
    related_skills: ['api-design-and-documentation']
---

## Overview
Document APIs using OpenAPI and Swagger.

## When to Use
- Design and implement
- Apply best practices
- Optimize performance
- Troubleshoot issues

## Common Pitfalls
1. Ignoring constraints
2. Skipping standards
3. Poor alignment
4. Inadequate testing
5. No documentation
6. Over-engineering
7. No rollback plan
8. No monitoring

## Verification Checklist
- [ ] Requirements validated
- [ ] Standards applied
- [ ] Design reviewed
- [ ] Tests defined
- [ ] Docs complete
- [ ] Monitoring configured
- [ ] Rollback planned
- [ ] Security checked