Skip to content
Back to skills

Api Doc Review

ASecurity

Verify that API endpoints match their OpenAPI/Swagger specifications.

  • 6 stars
  • 0 votes
  • 0 copies
  • 1 view
  • Added May 29, 2026
ai-agentsapidocumentation

Works with

  • api

Security analysis

A100/100

Scanned May 29, 2026

npx -y skills add yeaight7/agent-powerups --skill api-doc-review --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Api Doc Review?

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

Security grade badge for Api Doc Review
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/yeaight7-api-doc-review/badge)](https://www.skillsdirectory.com/skills/yeaight7-api-doc-review)

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: api-doc-review
description: "Verify that API endpoints match their OpenAPI/Swagger specifications."
---

# API Doc Review

Outdated API documentation causes integration failures. The code is the source of truth, and the docs must match.

## Review Protocol

1. Compare the route definition (e.g., `POST /users`) with the documented endpoint.
2. Verify that all required request parameters (body, query, params) are documented with correct types.
3. Verify that all possible response status codes (200, 400, 404, 500) and their payloads match the actual error handlers and return statements.
4. If there is a mismatch, update the OpenAPI spec or inline documentation immediately. Do not defer it.

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…