Skip to content
TrustedSkillsbeta
Back to all skills

Api Docs

Checked
leechael·vlatest·backend·MIT

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

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 leechael/fastapi-api-docs-skills --skill api-docs -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

leechael

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 leechael/fastapi-api-docs-skills at 37908622ae.

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

Scanned
2 files, 415 lines
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

What it does

This skill generates API documentation from FastAPI applications. It automatically extracts information about endpoints, parameters, and responses to create comprehensive and user-friendly documentation. The resulting documentation can be presented in various formats like Swagger UI or ReDoc.

When to use it

  • Documenting internal APIs: Quickly generate documentation for your team to understand and utilize internal services.
  • Creating public API references: Provide clear and accessible documentation for external developers using your API.
  • Automating documentation updates: Keep API documentation synchronized with code changes, reducing manual effort.
  • Generating interactive API explorers: Allow users to explore and test your API endpoints directly from the generated documentation.

Key capabilities

  • Generates OpenAPI specifications (Swagger)
  • Supports ReDoc rendering
  • Automated documentation updates based on FastAPI code
  • Provides interactive API exploration features

Example prompts

  • "Generate API documentation for my FastAPI application."
  • "Create Swagger UI documentation for the /users endpoint."
  • "Render the API documentation using ReDoc format."

Tips & gotchas

  • Requires a FastAPI application to be available. The skill will need access to inspect the code and generate documentation.