Skill Library 技能库Prompt Skill 迅速技能1 Designs 设计Top Views 俯视图

API Reference Endpoint ContractAPI 端点文档契约

Design, audit, or implement OpenAPI/Swagger API reference pages, endpoint pages, parameter tables, request/response schemas, status matrices, try-it consoles, and SDK/cURL examples.

设计、审计或实现 OpenAPI/Swagger API reference、端点页、参数表、请求/响应 schema、状态码矩阵、try-it 控制台和 SDK/cURL 示例。

Skill Uses 技能用0

记录的复用次数与项目引用。

Public Designs 公共设计1

按浏览量与收藏热度排序。

Prompt Lines 提示10

可复用的提示指令数量。

Author 作者@Interface Lab

实现

Skill Directive 技能指导

Description 描述

Design, audit, or implement OpenAPI/Swagger API reference pages, endpoint pages, parameter tables, request/response schemas, status matrices, try-it consoles, and SDK/cURL examples.

设计、审计或实现 OpenAPI/Swagger API reference、端点页、参数表、请求/响应 schema、状态码矩阵、try-it 控制台和 SDK/cURL 示例。

Tags 标签实现

Skill Prompt 技能提示

- 适用场景：API reference、endpoint docs、OpenAPI/Swagger、Redoc、Scalar、try it、request/response schema、auth scopes、webhook/event docs；输入必须包含 method/path、来源 spec、鉴权、参数、请求体、响应/错误、示例和目标渲染器。
- 先定义端点任务：发现能力、完成首次调用、配置鉴权、调试错误、迁移版本或比较端点；任务决定 schema 密度、示例数量、警告和 try-it 行为。
- 端点身份必须首屏可见：method、path、summary、operationId/tag、版本、稳定性、弃用/迁移说明和 source spec；method 颜色只能辅助，不能替代文字。
- 鉴权与安全先行：展示 auth type、header 形状、scope、tenant/project、sandbox/production；示例使用 YOUR_API_KEY，不展示真实 token；写操作 try-it 默认关闭或需要确认。
- 参数按 path/query/header/cookie 分组，required 优先；每项包含类型、默认值、enum/format、约束、描述、example 和编码说明。
- 请求体必须把 schema 和 example 配对；required nested fields、content type、nullable、file upload、validation、idempotency key 要明确。
- 响应必须有状态码矩阵：2xx、validation/auth/permission、not found/conflict、rate limit、async accepted、5xx；每行包含含义、schema/example、恢复动作和 retry 安全性。
- try-it/playground 要有环境选择、请求预览、发送/加载/成功/错误、copyable cURL、request ID、CORS/proxy 和 reset；破坏性方法要加显式摩擦。
- 代码示例调用 code-example-copy-contract：cURL/SDK tabs、复制反馈、占位符、语法高亮、clipboard fallback 和移动端局部滚动都要验收。
- 渲染器选择按任务：Swagger UI 适合标准交互式 OpenAPI 探索，Redoc 适合可读三栏静态 reference，Scalar 适合现代自托管 reference/API client；自研也必须满足同一契约。

当前展示公共摘要；登录 Pro 后可查看完整 prompt。

Layout Info 布局信息

下方作品按浏览量排序；前几项使用实时预览，其余保持快速缩略卡片。

Pro 解锁所有技能

API Reference Endpoint ContractAPI 端点文档契约

更多使用 API 端点文档契约 的页面

更多使用 API 端点文档契约的页面