Skip to content
TrustedSkillsbeta
Back to all skills

Api Docs Generator

Checked
patricio0312rev·vlatest·backend·MIT

Provides API guidance and assistance for writing, documentation, and content creation.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add patricio0312rev/skills --skill api-docs-generator -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

patricio0312rev

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.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

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 patricio0312rev/skills at 79ea6af485.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
79ea6af485
Manifest
backend/api-docs-generator/SKILL.md
Scanned
2 files, 1,734 lines
Copies in repo
2 — all of them scanned
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

api-docs-generator

What it does

This skill enables AI agents to automatically generate, update, and maintain API documentation based on codebases or schema definitions. It streamlines developer workflows by ensuring technical documentation stays synchronized with actual implementation details without manual intervention.

When to use it

  • You need to document a new REST or GraphQL API quickly after development is complete.
  • Your team requires up-to-date OpenAPI (Swagger) specifications for frontend integration.
  • You want to automate the maintenance of README files when API endpoints change frequently.
  • Developers need clear usage examples and parameter descriptions generated directly from code comments.

Key capabilities

  • Generates comprehensive API documentation from source code or schema inputs.
  • Creates structured content including endpoint lists, request/response formats, and authentication details.
  • Supports multiple output formats suitable for developer portals or internal wikis.
  • Reduces manual effort in keeping documentation aligned with code changes.

Example prompts

  • "Generate OpenAPI 3.0 documentation for my Express.js backend based on the provided route definitions."
  • "Create a Markdown README documenting the authentication flow and user endpoints for this API."
  • "Extract all GET and POST methods from this Python FastAPI codebase and format them as technical docs."

Tips & gotchas

Ensure your code includes clear comments or uses standard schema annotations (like Pydantic models) to maximize generation accuracy. The skill works best when the input code is well-structured and follows consistent naming conventions for endpoints and parameters.