API 端点文档

原名：document-api-endpoint

根据真实实现编写包含鉴权、参数、响应和错误码的 API 文档。

中文 Skills 技能说明

适合新增或变更接口后同步开发文档；先读取路由、控制器和测试，不编造字段或成功示例，敏感值只使用占位符。能力以本地代码库、文档和已授权 GitHub 环境为主；不会把私有代码、审查内容或企业资料默认发送给 Sentry 或其他外部服务。执行前应读取项目现状和官方文档，输出目标、依据、影响、验证结果与回退方式；没有真实证据时明确说明未知，不编造配置、数据或成功状态。创建、修改、训练、部署、发布、迁移、删除或产生费用的操作，必须先展示具体目标和差异并获得人工确认。代码、日志、令牌、连接串、模型、数据集和企业资料按敏感内容处理，只读取任务所需范围，上传或外发前完成授权、脱敏和最小化。

上游能力依据

上游原始适用说明：Document and type a Sentry API endpoint. Write or fix @extendschema decorators, specify response TypedDicts, type request parameters, correct type drift between the declared schema and the runtime response, and validate the generated spec. Use when asked to "document an endpoint", "add OpenAPI docs", "add/fix @extendschema", "type an endpoint response", "fix the response type", "fix type drift", "reuse a response type", "split an overloaded endpoint", "specify the response schema", "add a TypedDict response", "migrate a legacy api-docs path", "fix a parameter type", or "make an endpoint public" / "promote an endpoint" (promotion is one section here).

上游 SKILL.md 主要章节（保留原文标题）：

Workflow
Lessons
1. Carefully compare what the code does vs declared types
2. Reuse the canonical response type
3. Infer the type. Avoid cast and # type: ignore
4. Legacy doc migration is all-or-nothing per path
Promoting to PUBLIC
Validate

使用边界

先提供真实业务背景、目标受众和可核验资料。输出是工作草稿或决策辅助，不补造客户反馈、经营数据、案例或引用。

作者、翻译与许可证

原作者: Sentry 与 getsentry/skills contributors
中文翻译: CEOFans翻译
许可证: Apache-2.0
上游来源: https://github.com/getsentry/skills/tree/c2f99a5b04b4cd992ec3022d7c2c3e23e938d241/skills/document-api-endpoint

适用范围

平台：linux、macos、windows；标签：效率与知识、API 端点文档

安全提示

基础静态扫描不等于绝对安全。技能可能调用命令、浏览器、云服务或本地文件，请在最小权限环境中使用，高风险操作必须人工确认。

如发现侵权、许可证或安全问题，可在本页前台提交投诉，管理员复核后可立即下架。