api-docs
Document an HTTP API. Use when writing or updating an OpenAPI spec, describing endpoints, request and response fields, error codes, or adding examples to API reference pages.
- License 许可
- MIT
- 最近更新
- 2026-09-29
- Stars
- ★ 1
- Forks
- 1
01 前言 Front Matter
- name
- api-docs
- description
- Document an HTTP API. Use when writing or updating an OpenAPI spec, describing endpoints, request and response fields, error codes, or adding examples to API reference pages.
03 SKILL.md 正文
- Start from the handler code, not from memory.
- Describe every field, its type and whether it is required.
- Give one working example per endpoint.
04 同仓库更多 Skills
test-guard
Stabilise tests that fail only sometimes. Use when a test passes on retry, fails in CI but not locally, depends on timing, ordering or shared state, or is quarantined as flaky.
perf-profile
Find why code is slow or uses too much memory. Use when a request or job got slower, latency or CPU grew, memory leaks, or the user asks to profile or benchmark something.
find-bug
Find the root cause of a failure that happens every time. Use when a test fails consistently, an endpoint returns an error, a service crashes or a stack trace needs explaining ("why does X fail", "where does this error come from").
db-migrations
Write safe PostgreSQL schema migrations. Use when adding or dropping a column, table or index, changing a column type, or backfilling data on a live database without locking writes.
changelog
Write release notes and changelog entries from commits and merged pull requests. Use when preparing a release, bumping a version, or summarising what changed since the last tag for users.
test-guard
Helps with tests.