Api Documentation Generator
CheckedHelps 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-generator -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 passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.
Declares what it does: passed
SKILL.md parses and declares a name and a description.
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
- 1 file, 483 lines
- Copies in repo
- 3 — all of them scanned
About this skill
What it does
This skill automates the generation of API documentation from code, saving time and reducing errors. It parses endpoints, parameters, request/response formats, and other relevant details directly from the source code to create clear, structured documentation.
When to use it
- You need to update API docs frequently as your backend evolves.
- You want to ensure consistency between your code and documentation without manual effort.
- Your team is onboarding new developers who require up-to-date API references.
- You're building a public-facing API that requires well-documented endpoints for third-party use.
Key capabilities
- Parses source code to extract endpoint details automatically
- Supports multiple programming languages (e.g., Python, JavaScript)
- Generates markdown or HTML documentation formats
- Includes examples of requests and responses
Example prompts
- "Generate API documentation for my Flask backend."
- "Create a markdown file with all the endpoints from this Node.js project."
- "Update the API docs based on the latest changes in the codebase."
Tips & gotchas
- Ensure your code is well-commented to get accurate and meaningful documentation.
- Some frameworks or custom routing may require additional configuration for proper parsing.