Skip to content
TrustedSkillsbeta
Back to all skills

Api Documenter

Checked
ovachiever·vlatest·backend

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 ovachiever/droid-tings --skill api-documenter -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

ovachiever

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 ovachiever/droid-tings at 7acd12a754.

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

Commit
7acd12a754
Manifest
skills/api-documenter/SKILL.md
Scanned
2 files, 297 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

The API Documenter skill transforms raw code snippets, OpenAPI specifications, or database schemas into comprehensive, human-readable documentation. It automatically generates structured guides including endpoint descriptions, request/response formats, and usage examples to streamline developer onboarding.

When to use it

  • You have a new REST API built with FastAPI, Express, or Django and need immediate technical documentation without writing it manually.
  • Your team is integrating a third-party service via JSON-RPC or GraphQL and requires clear parameter definitions and error codes.
  • You are maintaining legacy codebases where original comments are missing or outdated, needing to reverse-engineer functionality from the source.

Key capabilities

  • Parses various input formats including OpenAPI/Swagger YAML/JSON files and raw Python/JavaScript function definitions.
  • Generates structured markdown output containing endpoint summaries, method details (GET, POST, PUT), and data models.
  • Extracts and documents authentication requirements, rate limits, and specific error handling scenarios from the code logic.

Example prompts

  • "Analyze this OpenAPI YAML file and generate a Markdown guide explaining how to create a new user account."
  • "Review these Python FastAPI route definitions and document the input validation rules for the payment processing endpoint."
  • "Convert this database schema definition into a reference document detailing the relationships between the orders and customers tables."

Tips & gotchas

Ensure your source code includes clear docstrings or standard metadata tags, as the tool relies on these to populate accurate descriptions. Complex nested logic may require manual review of the generated output to verify edge cases are correctly interpreted.