api-design

仓库创建 2026年7月27日最近提交 1 天前SkillHot 收录 1 天前

▸ 精选理由

规则可追溯、覆盖版本化与错误契约，适合架构与审查场景。

这个 Skill 做什么

为 REST API 提供可引用规则、规范与审查建议。

提供可落地的 REST API 设计和审查建议：资源命名、版本策略、分页、错误契约、幂等性、长任务处理以及 OpenAPI 规范等都能覆盖。在新建接口、写 OpenAPI 文档、选状态码或审查兼容性变更时用得上。特点是基于规则化的建议（带 MUST/SHOULD 级别），便于团队对照执行和引用。

▸ 展开 SKILL.md 英文原文

Designs and reviews REST APIs: resource naming, versioning, pagination, error contracts, idempotency, long-running operations, OpenAPI. Use when creating endpoints, writing OpenAPI specs, choosing status codes, or reviewing API changes for breaking compatibility.

开发编程API 设计OpenAPI兼容性通用

Stars

Forks

仓库内 Skill

积累中

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/Ludenox-GIT/portable-agent-skills/main/skills/api-design/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/Ludenox-GIT/portable-agent-skills/main/skills/api-design/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

# REST API Design

Rules use RFC-2119 keywords (MUST / SHOULD / MAY) and are numbered so findings are citable: "violates rule #32". Rule numbers below match the full pack in references/RULES.md (load when doing a full API review or authoring a spec from scratch — 54 rules with rationale). `(Z-###)` marks the corresponding rule in the Zalando RESTful API Guidelines.

## When to use

- Designing new REST endpoints or whole APIs; writing or reviewing OpenAPI specs.
- Choosing status codes, error shapes, pagination, versioning, idempotency strategy.
- Reviewing a PR that touches public API surface for breaking changes.

Do NOT use for: GraphQL or gRPC schema design, debugging a client that consu

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有