Skip to content
TrustedSkillsbeta
Back to all skills

Backend Api Documenter

Checked
realroc·vlatest·backend

Helps with backend development, API as part of writing, documentation, and content creation workflows.

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 realroc/skills --skill backend-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

realroc

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 realroc/skills at ad2207fcce.

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

Commit
ad2207fcce
Manifest
skills/backend-api-documenter/SKILL.md
Scanned
3 files, 376 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

The backend-api-documenter skill automatically generates documentation from a provided OpenAPI (Swagger) specification file. It parses the YAML or JSON definition and outputs formatted markdown suitable for developer portals, internal wikis, or API reference guides. This allows teams to keep their API documentation up-to-date without manual effort.

When to use it

  • Automating API Documentation: When you have an OpenAPI specification (Swagger) file and need to quickly generate human-readable documentation.
  • Internal Developer Portals: To provide developers with a clear and concise reference for your backend APIs.
  • Keeping Documentation Current: As your API evolves, automatically update the documentation whenever the OpenAPI spec changes.
  • Generating Release Notes: Quickly create summaries of API changes based on updates to the specification.

Key capabilities

  • Parses OpenAPI (Swagger) specifications in YAML or JSON format.
  • Generates Markdown output from the specification.
  • Suitable for developer portals and internal wikis.

Example prompts

  • "Document this API: [paste OpenAPI spec here]"
  • "Generate markdown documentation for my backend API."
  • "Create a developer-friendly guide from this Swagger file: [file path]"

Tips & gotchas

The skill requires a valid OpenAPI (Swagger) specification in either YAML or JSON format. Ensure the provided specification is well-formed to avoid errors during processing and generation of documentation.