Skip to content
TrustedSkillsbeta
Back to all skills

Backend Api Documenter

Checked
realroc·vlatest·backend·MIT

Helps with backend development, API as part of developing backend services and APIs 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/backend-api-documenter --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/backend-api-documenter at 20a27ee0c7.

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

Commit
20a27ee0c7
Manifest
SKILL.md
Scanned
5 files, 434 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 realroc-backend-api-documenter skill automatically generates API documentation from backend code. It parses code to identify endpoints, request parameters, and response structures. The generated documentation is formatted for easy readability and understanding by developers.

When to use it

  • Onboarding new team members: Quickly provide clear documentation of your existing APIs so new developers can understand and utilize them efficiently.
  • Maintaining API consistency: Ensure your API documentation stays up-to-date with code changes, reducing errors and inconsistencies.
  • Generating public API references: Create a readily available resource for external developers to integrate with your backend services.
  • Automating tedious documentation tasks: Eliminate the manual effort of writing and maintaining API documentation.

Key capabilities

  • Code parsing
  • Endpoint identification
  • Request parameter extraction
  • Response structure analysis
  • Documentation generation

Example prompts

  • "Document the backend API for my project located at /path/to/backend."
  • "Generate API documentation in Markdown format from this code: [paste code here]."
  • “Create a Swagger specification based on the endpoints defined in /src/api.js.”

Tips & gotchas

The skill requires access to the backend codebase. Ensure appropriate permissions are granted for accurate parsing and documentation generation.