Skip to content
TrustedSkillsbeta
Back to all skills

Api Reference Documentation

Checked
aj-geddes·vlatest·backend·MIT

Helps with API, documentation 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 aj-geddes/useful-ai-prompts --skill api-reference-documentation -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

aj-geddes

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 aj-geddes/useful-ai-prompts at 3f5182cfd7.

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

Commit
3f5182cfd7
Manifest
skills/api-reference-documentation/SKILL.md
Scanned
5 files, 543 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 clear, structured documentation for API endpoints based on raw specifications or code. It transforms technical details into readable guides that explain request parameters, response formats, and usage examples.

When to use it

  • You have a Swagger/OpenAPI JSON file but need human-readable text descriptions for your team.
  • You are documenting a new internal microservice and want consistent formatting across all endpoints.
  • You need to convert complex GraphQL schemas into simple "how-to" instructions for frontend developers.

Key capabilities

  • Parses raw API definitions (JSON, YAML, or Markdown) to extract endpoint logic.
  • Generates standardized sections including headers, query parameters, and response bodies.
  • Produces usage examples with realistic request/response pairs in code blocks.
  • Adapts tone and depth based on the target audience (e.g., developers vs. product managers).

Example prompts

  • "Convert this OpenAPI JSON specification into a Markdown documentation file with clear headers for each endpoint."
  • "Explain how to use the /users API endpoint, including required authentication headers and common error codes."
  • "Generate a quick-start guide for integrating the payment gateway API, focusing on the POST /charge method."

Tips & gotchas

Ensure you provide complete context, such as the full OpenAPI spec or relevant code snippets, to avoid hallucinated parameters. If your API uses custom authentication flows, explicitly describe those steps so the agent can include them in the generated guide.