Api Documentation
ListedHelps with API, documentation as part of writing, documentation, and content creation workflows.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add sickn33/agentic-awesome-skills --skill api-documentation -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
sickn33
Taken from the source listing. We haven't verified who controls this account.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
This skill failed 1 of 6 checks. A failure is not proof of bad intent; it means something in the code needs a human to look at it before you run it.
Declares what it does: failed
No SKILL.md was found in the skill's directory.
SKILL.md exists, its frontmatter parses, and it declares a name and a description.
No undeclared network calls: passed
Makes no network calls.
Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.
No obfuscated payloads: passed
No encoded or obfuscated payloads.
No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.
No credential access: passed
Reads no keys, tokens, keychains or credential files.
Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.
No pipe-to-shell installers: passed
No pipe-to-shell or download-and-run installers.
No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.
Pinned to a commit: passed
Scanned sickn33/antigravity-awesome-skills at 5a4cdd9df8.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- 5a4cdd9df8
- Scanned
- 0 files
- Copies in repo
- 3 — all of them scanned
About this skill
What it does
This skill enables AI agents to generate, format, and maintain comprehensive API documentation directly from code or specifications. It transforms raw endpoint definitions into readable guides that include request/response examples, parameter descriptions, and usage instructions.
When to use it
- You need to document a new REST or GraphQL API for your development team.
- You want to convert Swagger/OpenAPI JSON files into human-readable Markdown or HTML pages.
- You are building an internal tool and require automated documentation updates as endpoints change.
- You need to create quick reference guides for external developers integrating with your service.
Key capabilities
- Parses API definitions (OpenAPI/Swagger) to extract endpoint details.
- Generates structured documentation including headers, query parameters, and body schemas.
- Creates example requests and responses in various formats (JSON, cURL).
- Supports multiple output formats like Markdown, HTML, and reStructuredText.
Example prompts
"Generate API documentation for this OpenAPI spec file: [paste_spec]" "Create a Markdown guide for the /users endpoint including authentication requirements." "Convert my Swagger JSON into a formatted README with code examples in Python and JavaScript."
Tips & gotchas
Ensure your input data (OpenAPI/Swagger specs) is valid and complete, as missing schema details will result in incomplete documentation. This skill works best when paired with version control workflows to keep docs synchronized with live API changes.