Query Swagger/OpenAPI sources for modules, endpoints, request/response fields, reusable schemas and DTOs, or export Markdown/JSON API documentation.

Apache-2.0Auto-check passedBackend & APIs

Install Swagger Doc Skill

skills CLI
$ npx skills add hashgraph-online/awesome-codex-plugins --skill swagger-doc-skill -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install hashgraph-online/awesome-codex-plugins swagger-doc-skill --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/hashgraph-online/awesome-codex-plugins.git skills-src && mkdir -p .claude/skills && cp -r skills-src/plugins/Jason-chen-coder/dev-skills/skills/swagger-doc-skill .claude/skills/swagger-doc-skill && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
swagger-doc-skill
GitHub stars
1.2k
Token cost
~1.6k tokens
SKILL.md length
749 words
Files
8 (incl. scripts, references)
Skills in repo
686
Repo updated
First seen
Licence
Apache-2.0

At a glance

Query Swagger/OpenAPI sources for modules, endpoints, request/response fields, reusable schemas and DTOs, or export Markdown/JSON API documentation.

  • Works in 3 steps: Use the docs URL, local specification,… → Reuse an unambiguous source already… → If several sources remain plausible, ask…
  • Tasks that involve OpenAPI specifications
  • SKILL.md covers Document Source, Query Workflow, Output And Verification and Runtime And Failures, plus 2 more sections
  • Runs JavaScript scripts from its folder; calls node

What it does

Swagger Doc Skill is an agent skill from hashgraph-online/awesome-codex-plugins. Query Swagger/OpenAPI sources for modules, endpoints, request/response fields, reusable schemas and DTOs, or export Markdown/JSON API documentation. Use with Swagger UI, Knife4j, FastAPI docs, Redoc, OpenAPI JSON/YAML, and Swagger 2.0 URLs or local specifications, including endpoint integration lookups.

Its SKILL.md is about 1.6k tokens, which your agent loads only when the skill is triggered. The skill folder holds 10 other files, including scripts and reference files (for example `agents/openai.yaml`, `references/dev-baseline.md` and `references/extractor-usage.md`).

It sits in Backend & APIs, covering OpenAPI specifications. It works with OpenAPI and FastAPI. The repository describes itself as: A curated list of awesome OpenAI Codex / ChatGPT plugins, skills, and resources. The 1 Codex Marketplace. See live plugins at: https://hol.org/plugins/best-codex-plugins. The licence is Apache-2.0.

When your agent uses it

  • Tasks that involve OpenAPI specifications

Example prompts

  • “/swagger-doc-skill”

Requirements

  • Node.js

Workflow steps

3 steps, taken from the first numbered list in SKILL.md.

  1. Use the docs URL, local specification, or config path provided in this request.
  2. Reuse an unambiguous source already confirmed in this chat for follow-ups.
  3. If several sources remain plausible, ask which one applies. If none is

What it can do on your machine

Read from SKILL.md and the folder at commit 78497e5. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships 2 files in scripts/ (JavaScript), which the agent can run.

    Shell commands in SKILL.md call:

    • node

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Swagger Doc Skill loads about 1.6k tokens when it runs, and up to ~4.4k if it reads all its reference files. Until then it costs about 81 tokens; SKILL.md has 749 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~81
When it runs · the whole SKILL.md, loaded when a task matches
~1.6k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~4.4k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); the scripts in this folder are not scanned.

SKILL.md

The full file from hashgraph-online/awesome-codex-plugins at commit 78497e5, republished under its Apache-2.0 licence (© hashgraph-online). 749 words, ~1,582 tokens.

Download SKILL.mdSave it as .claude/skills/swagger-doc-skill/SKILL.md (or your agent's skills folder). This skill also uses 7 other files; get the full folder from GitHub.
name
swagger-doc-skill
description
Query Swagger/OpenAPI sources for modules, endpoints, request/response fields, reusable schemas and DTOs, or export Markdown/JSON API documentation. Use with Swagger UI, Knife4j, FastAPI docs, Redoc, OpenAPI JSON/YAML, and Swagger 2.0 URLs or local specifications, including endpoint integration lookups.

Swagger Doc Skill

Read references/dev-baseline.md once per task. Use the bundled Node.js extractor for consistent discovery, schema resolution, and exports. Resolve <skill-dir> to the absolute directory containing this SKILL.md.

Document Source

  1. Use the docs URL, local specification, or config path provided in this request.
  2. Reuse an unambiguous source already confirmed in this chat for follow-ups.
  3. If several sources remain plausible, ask which one applies. If none is available, ask for a Swagger/OpenAPI URL, local spec, or config path.

Do not inherit Swagger sources across chats. Do not guess documentation URLs, scan unrelated hosts, or invent endpoints. If the task is about an SDK without an OpenAPI source, use its official documentation workflow instead.

The script only reads config files when --config <path> is passed explicitly. Do not rely on shared defaults or persist chat URLs, tokens, or headers into the skill's configuration. Keep credential-bearing project configs untracked. Do not expose secret values in commands shown to the user, logs, or documents. State the active source with the result, redacting URL credentials or tokens.

Query Workflow

Choose the smallest output that answers the request:

IntentScript mode and filters
Modules/tags/controllers--mode modules
Endpoint list--mode endpoints; narrow with --tag, --method, --path, --search
One endpoint's request/response--mode endpoint --path <path> --method <METHOD>
Feature integrationFind candidates with endpoints, then use integration with the matched method/path
Reusable types/models/DTOs--mode types; narrow with --type or --search
Full export--mode document --output <file.md>; add --format json for JSON
bash
node "<skill-dir>/scripts/extract_swagger_docs.mjs" "<docs-url-or-local-spec>" --mode modules
node "<skill-dir>/scripts/extract_swagger_docs.mjs" "<source>" --mode endpoints --search "登录"
node "<skill-dir>/scripts/extract_swagger_docs.mjs" "<source>" --mode integration --path "/api/user/login" --method POST
node "<skill-dir>/scripts/extract_swagger_docs.mjs" --config ./swagger.config.json --mode document --output swagger-api.md

For a UI page, let the extractor discover its backing specification. Review the requested result against the extracted methods, paths, and schemas. Output size should follow the request: a single field question does not need a full export.

For feature lookup, --search includes common Chinese/English intent synonyms. Use endpoint descriptions and the user's context to narrow candidates. Ask only when materially different candidates remain plausible; multiple text matches alone do not require a question. If no match exists, try a few relevant adjacent terms, then report the gap. Integration guidance requires an endpoint actually present in the confirmed spec.

Output And Verification

Preserve exact HTTP methods, paths, schema names, required fields, enum/default values, content types, response statuses, base URLs, and documented auth. Resolve local $ref and legacy originalRef where possible. Full exports include reusable components.schemas / Swagger 2 definitions, not just endpoint summaries. Mark unresolved references and recursive expansion limits.

Generated request examples and fields inferred from examples are illustrations, not additional contract guarantees. Missing auth documentation does not prove that the deployed endpoint is public. Do not execute generated API calls merely to verify documentation.

For full exports, check source/module/endpoint/type counts, required sections, and unresolved schemas. For focused queries, verify the selected endpoint or type and its relevant fields. A successful extraction proves what the source documents, not production behavior or server reachability.

Read references/output-format.md for full export sections, schema formatting, and integration-example requirements. Read references/extractor-usage.md for config, cache, headers, detailed command options, and discovery failures.

Show full SKILL.md (257 more words)Show less

Runtime And Failures

JSON specs and Swagger UI extraction use Node.js built-ins. Direct YAML input requires the optional yaml package; if unavailable, use an available JSON export or report the dependency and request the missing source as needed.

If a reachable docs page cannot be resolved, inspect its configuration/network for a direct spec and retry that evidenced URL. If the input URL itself times out or fails to fetch, report the failure instead of probing many fallback paths. For authentication failures, use existing authorized access or request an export or suitable credential mechanism. Keep partial results and unresolved items explicit; never fill missing schemas or endpoint meaning from memory.

SDD Evidence Contract

Use the active source, exact method/path, request shape, and response schema as evidence for an existing spec or plan. Cite the endpoint and source in a handoff. Report conflicts with a plan, generated client, or local DTO explicitly. Documentation lookup alone does not authorize editing SDD artifacts or clients; make those changes when they are part of the user's requested implementation.

Multi-Agent Profile

Recommended agent_type: explorer

Delegate only when available and useful for a bounded, independent extraction. Provide the confirmed source and requested endpoint/type or export scope. The worker inherits source isolation and secret handling above and returns the active source, requested result/file, verification command, and relevant counts or unresolved schemas. It does not infer endpoints or expand into API writes.

When running from this repository, use ../../docs/multi-agent-policy.md as the extended policy. Standalone installs rely on this profile and do not require that repository file.

© hashgraph-online, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 7 other files (scripts, references) in plugins/Jason-chen-coder/dev-skills/skills/swagger-doc-skill of hashgraph-online/awesome-codex-plugins.

  • SKILL.md
  • agents/openai.yaml
  • references/dev-baseline.md
  • references/extractor-usage.md
  • references/output-format.md
  • scripts/extract_swagger_docs.mjs
  • scripts/extract_swagger_docs.test.mjs
  • swagger.config.example.json

Open the folder on GitHubat commit 78497e5

Compare with similar skills

Swagger Doc Skill next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Swagger Doc Skill compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Swagger Doc Skill this skillhashgraph-online/awesome-codex-plugins1.2k—~1.6kAutomated safety check: PassApache-2.0
API Surface Reviewpolarsource/polar10k—~1.3kAutomated safety check: PassMIT
FastAPI ExpertJeffallan/claude-skills12k—~1.8kAutomated safety check: PassMIT
Route To Openapizebbern/claude-code-guide4.7k—~1.1kAutomated safety check: PassMIT
Fastapi Init Skilljiushiwon/wg-skills112—~1.8kAutomated safety check: NotesApache-2.0
Implementing API Patternsancoleman/ai-design-components5261 repos~3kAutomated safety check: PassMIT

Similar skills

  • API Surface Review

    polarsource/polar

    Review changes to Polar's API contract — Pydantic schemas, FastAPI endpoints, OpenAPI output and the generated SDKs.

    10k GitHub stars~1.3k tokensUpdated today
    Backend & APIsAuto-check passed
  • FastAPI Expert

    Jeffallan/claude-skills

    Builds async Python APIs with FastAPI and Pydantic V2, covering endpoints, JWT authentication, async SQLAlchemy, WebSockets and pytest checks against the OpenAPI docs.

    12k GitHub stars~1.8k tokensUpdated 5 days ago
    Backend & APIsAuto-check passed
  • Route To Openapi

    zebbern/claude-code-guide

    Generates RESTful API documentation (OpenAPI 3.0 / Swagger spec) by scanning route definitions in code for Flask, FastAPI, Express, Gin, and other frameworks.

    4.7k GitHub stars~1.1k tokensUpdated today
    Backend & APIsAuto-check passed
  • Fastapi Init Skill

    jiushiwon/wg-skills

    FastAPI 项目一键初始化技能。面向零基础小白,提供环境探测、自动安装、完整 Web 骨架生成、SSE 流式框架、JWT 鉴权、统一响应封装、文件上传接口、一键启动/重启脚本、Swagger 文档,内置 MySQL(默认)/ PostgreSQL / MongoDB 数据库选择。用户只需说"帮我搭一个 FastAPI 项目"即可一条命令完成从零到跑的完整链路。触发词:"FastAPI…

    112 GitHub stars~1.8k tokensUpdated yesterday
    Backend & APIsAuto-check: notes
  • Implementing API Patterns

    ancoleman/ai-design-components

    API design and implementation across REST, GraphQL, gRPC, and tRPC patterns.

    526 GitHub starsUsed in 1 repo~3k tokens
    Backend & APIsAuto-check passed
  • Python Fastapi Patterns

    aiskillstore/marketplace

    FastAPI web framework patterns. An agent skill from aiskillstore/marketplace.

    430 GitHub starsUsed in 1 repo~1.3k tokens
    Backend & APIsAuto-check: notes

More from hashgraph-online/awesome-codex-plugins

All 686 skills in this repo
  • Anime Reaction Gif

    hashgraph-online/awesome-codex-plugins

    Create original anime-style reaction stickers as looping GIFs and MP4 previews, using generated character pose sheets and timed key poses.

    1.2k GitHub stars~922 tokensUpdated today
    Auto-check passed
  • Calibredb

    hashgraph-online/awesome-codex-plugins

    Manage and query Calibre libraries with the calibredb CLI (local paths or Calibre Content server URLs).

    1.2k GitHub stars~1k tokensUpdated today
    Auto-check passed
  • Rust API Test Harness

    hashgraph-online/awesome-codex-plugins

    A skill your agent uses when adding, changing, testing, or debugging Rust HTTP APIs and services, especially when Codex needs black-box integration tests, random-port app startup, real database test…

    1.2k GitHub stars~1.7k tokensUpdated today
    Auto-check passed
  • Art

    hashgraph-online/awesome-codex-plugins

    Make a studio's game look like something at build time — a cover from a real frame of the game (free), painted covers, backdrops, textures and character plates from image models through the…

    1.2k GitHub stars~2.4k tokensUpdated today
    Auto-check passed
  • Game Balance Economy

    hashgraph-online/awesome-codex-plugins

    Balance game difficulty, resources, rewards, probability, progression, economies, and dominant strategies.

    1.2k GitHub stars~618 tokensUpdated today
    Auto-check passed
  • Manuscript Engagement Analytics

    hashgraph-online/awesome-codex-plugins

    Analyze nonfiction manuscripts for reader engagement signals, including heading-level word counts, slow starts, long slogs, weak takeaway titles, value pacing, beta-reader comment dropoff, and…

    1.2k GitHub stars~875 tokensUpdated today
    Auto-check passed

Works with

Categories

Questions about Swagger Doc Skill

What does Swagger Doc Skill do?

Query Swagger/OpenAPI sources for modules, endpoints, request/response fields, reusable schemas and DTOs, or export Markdown/JSON API documentation. Swagger Doc Skill is an agent skill from hashgraph-online/awesome-codex-plugins. Query Swagger/OpenAPI sources for modules, endpoints, request/response fields, reusable schemas and DTOs, or export Markdown/JSON API documentation.

When should I use Swagger Doc Skill?

Swagger Doc Skill fits situations like: tasks that involve OpenAPI specifications.

How do I install Swagger Doc Skill in Claude Code?

Run `npx skills add hashgraph-online/awesome-codex-plugins --skill swagger-doc-skill -a claude-code`. Or copy the skill folder (plugins/Jason-chen-coder/dev-skills/skills/swagger-doc-skill in hashgraph-online/awesome-codex-plugins) into .claude/skills/swagger-doc-skill in your project. Claude Code loads it when a task matches its description.

How do I install Swagger Doc Skill in Codex?

Run `npx skills add hashgraph-online/awesome-codex-plugins --skill swagger-doc-skill -a codex`. Or copy the skill folder (plugins/Jason-chen-coder/dev-skills/skills/swagger-doc-skill in hashgraph-online/awesome-codex-plugins) into .agents/skills/swagger-doc-skill in your project. Codex loads it when a task matches its description.

Can I use Swagger Doc Skill in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add hashgraph-online/awesome-codex-plugins --skill swagger-doc-skill -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/swagger-doc-skill, .gemini/skills/swagger-doc-skill, .github/skills/swagger-doc-skill and .opencode/skills/swagger-doc-skill in your project.

What does Swagger Doc Skill need to run?

Going by SKILL.md and its folder, Swagger Doc Skill needs JavaScript for the scripts in its folder and the command-line tools its instructions call (node). Our summary lists: Node.js.

Does Swagger Doc Skill access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Swagger Doc Skill safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.

What licence does Swagger Doc Skill use?

Swagger Doc Skill is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Swagger Doc Skill use?

About 1.6k tokens (SKILL.md is roughly 6.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 2.8k tokens, read only when the agent opens those files.

What are the alternatives to Swagger Doc Skill?

Skills that share tags, products or a category with Swagger Doc Skill: API Surface Review (polarsource/polar, 10k stars), FastAPI Expert (Jeffallan/claude-skills, 12k stars), Route To Openapi (zebbern/claude-code-guide, 4.7k stars) and Fastapi Init Skill (jiushiwon/wg-skills, 112 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Swagger Doc Skill?

hashgraph-online (a GitHub organization) maintains it in hashgraph-online/awesome-codex-plugins, which has 1,242 GitHub stars. The repository holds 686 skills in this directory. The repository was last updated on October 8, 2026.

Source: hashgraph-online/awesome-codex-plugins on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.