Skip to content
Back to skills

Docs Api

ASecurity

Сгенерировать docs/API.md из OpenAPI/Swagger-спеки — таблица эндпоинтов, параметры/ответы, curl-примеры (роль docs). Use когда нужна человекочитаемая API-документация поверх спеки.

  • 2 stars
  • 0 votes
  • 0 copies
  • 1 view
  • Added September 11, 2026
documentationbashapidocumentation

Works with

  • api

Security analysis

A100/100

Scanned September 11, 2026

npx -y skills add Vitammiin/agent-vorcl-flow --skill docs-api --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Docs Api?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Docs Api
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/vitammiin-docs-api/badge)](https://www.skillsdirectory.com/skills/vitammiin-docs-api)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: docs-api
description: Сгенерировать docs/API.md из OpenAPI/Swagger-спеки — таблица эндпоинтов, параметры/ответы, curl-примеры (роль docs). Use когда нужна человекочитаемая API-документация поверх спеки.
---

# Задача: docs/API.md из OpenAPI-спеки

Сгенерируй `docs/API.md` из OpenAPI-спеки (см. `$api-design`, `$swagger-coverage`).

1. Найди спеку: статическая `openapi.{yaml,json}`, рантайм-эндпоинт (`/documentation/json` · `/api-json` · `/openapi.json` · `/v3/api-docs`) или генератор.
2. **Спеки нет — не выдумывай API по коду**: остановись и предложи сначала `$swagger-audit` → `$swagger-cover`; документировать нечего, пока контракта нет.
3. Сводная таблица эндпоинтов (метод, путь, `summary`, auth, теги), группировка по тегам. По каждой операции: параметры, `requestBody`, `responses` по кодам — **только из спеки**.
4. curl-примеры на ключевые операции: реальные поля из схем, плейсхолдеры `<TOKEN>`, базовый URL из `servers`; синтаксис проверь (`bash -n`).
5. Версия — из `info.version`; в шапке файла — источник спеки и дата генерации.

Отдай путь к `docs/API.md` + источник спеки + число задокументированных операций (сверь со спекой). Опирайся на `$technical-writing`.

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.