Use when documenting APIs.
Scanned 9/10/2026
Install to Claude Code
Skills Directorynpx -y skills add LoopyLuci/Skills --skill api-documentation --agent claude-codeInstalls into .claude/skills of the current project.
Are you the author of Api Documentation?
Add the live security badge to your README — it updates automatically with every re-scan.
[](https://www.skillsdirectory.com/skills/loopyluci-api-documentation)More formats (shields.io, HTML) on the badges page.
---
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
Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.
No comments yet. Be the first to comment!
