Agent skill

http-api-openapi

Keep HTTP handlers and OpenAPI (openapi.yaml) in sync. Use when adding/changing endpoints, request/response schemas, auth requirements, or error shapes.

Stars 163
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/http-api-openapi

Metadata

Additional technical details for this skill

repo
mjrwtf
runner
github-copilot-cli
version
1.2

SKILL.md

Tooling assumptions

  • Use a terminal runner with bash and git available.
  • Prefer make targets when available; fall back to direct CLI commands when needed.

Source of truth

  • OpenAPI spec: openapi.yaml at the repo root.

Typical workflow

  1. Update openapi.yaml (paths, schemas, auth).
  2. Validate the spec:
bash
make validate-openapi

If swagger-cli isn’t installed:

bash
npm install -g @apidevtools/swagger-cli
  1. Implement the handler changes in Go (and keep auth consistent with the spec).
  2. Run tests:
bash
make test

Project-specific notes

  • Authenticated endpoints use Bearer token auth (see README’s Auth section).
  • Be explicit about error responses and status codes in the spec when behavior changes.

Didn't find tool you were looking for?

Be as detailed as possible for better results