技能 api-designer
📦
api-designer
内容修订 r3 安全 ⚙️ 外部命令🌐 网络访问🔑 环境变量📁 文件系统访问
设计可靠的 REST 和 GraphQL API
API 团队需要一致的端点、身份验证和文档。此技能指导 REST、GraphQL、OpenAPI、版本控制和安全设计决策。
支持: Claude Codex Code(CC)
使用我的智能体安装
将此请求复制给你的智能体，其中包含权威 Skill 页面和清单。
智能体请求
Review the Skillstore skill "api-designer" from https://skillstore.io/skills/autumnsgrove-api-designer.md and its manifest at https://skillstore.io/api/skills/autumnsgrove-api-designer/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.你的智能体仍应展示其计划，并按安全策略请求必要确认。
Agent 可读资源
当 AI Agent、爬虫或脚本需要干净上下文，而不是读取完整页面时，请使用这些链接。
测试它
正在使用“api-designer”。 设计一个包含用户、文章、评论和标签的博客 API。
预期结果:
- 用户、文章、评论和标签的资源映射。
- 包含方法、状态码、分页和筛选的端点计划。
- 针对公开和私有操作的身份验证与授权建议。
正在使用“api-designer”。 为一个将重命名客户字段的 API 规划版本控制。
预期结果:
- 建议发布新的主版本，因为客户端会看到破坏性的字段变更。
- 包含警告标头、迁移指南和平行支持期的弃用时间线。
- 面向 SDK、文档、监控和客户端沟通的兼容性清单。
正在使用“api-designer”。 审查一个在查询参数中暴露 API 密钥的 API。
预期结果:
- 关于日志记录和浏览器历史暴露的安全顾虑。
- 建议使用授权标头和限定作用域的密钥。
- 更新关于轮换、过期和使用日志记录的文档。
安全审计
安全v14 • 2026/7/23 打开版本化报告
All 146 static findings are false positives caused by Markdown syntax, example URLs and credentials, validation text, and intended local file output. The Python helper does not spawn commands, read environment variables, access certificate files, or make network requests. No prompt injection, exfiltration intent, or other semantic security issue was found.
9
已扫描文件
5,100
分析行数
0
复核项
0
已忽略误报
风险因素
⚙️ 外部命令 (50)
examples/openapi_spec.yaml:760 scripts/api_helper.py:230 scripts/api_helper.py:238 scripts/api_helper.py:262 scripts/api_helper.py:270 scripts/api_helper.py:277 SKILL.md:65-81 SKILL.md:81-88 SKILL.md:88 SKILL.md:89 SKILL.md:92-95 SKILL.md:95-105 SKILL.md:105-124 SKILL.md:124 SKILL.md:125 SKILL.md:128-140 SKILL.md:140-147 SKILL.md:147-162 SKILL.md:162-165 SKILL.md:165-166 SKILL.md:166-167 SKILL.md:167-168 SKILL.md:168-169 SKILL.md:169-170 SKILL.md:170-171 SKILL.md:171-172 SKILL.md:172-173 SKILL.md:173-174 SKILL.md:174-179 SKILL.md:179-190 SKILL.md:190-193 SKILL.md:193-205 SKILL.md:205-207 SKILL.md:207-215 SKILL.md:215-234 SKILL.md:234-240 SKILL.md:240-258 SKILL.md:258-264 SKILL.md:264-281 SKILL.md:281-283 SKILL.md:283-290 SKILL.md:290-296 SKILL.md:296-299 SKILL.md:299-306 SKILL.md:306-309 SKILL.md:309-313 SKILL.md:313-318 SKILL.md:318-329 SKILL.md:329-332 SKILL.md:332-334
🌐 网络访问 (37)
examples/openapi_spec.yaml:20 examples/openapi_spec.yaml:24 examples/openapi_spec.yaml:27 examples/openapi_spec.yaml:29 examples/openapi_spec.yaml:31 references/authentication.md:189 references/authentication.md:190 references/authentication.md:244 references/authentication.md:245 references/common-patterns.md:296 references/common-patterns.md:173 references/common-patterns.md:183 references/common-patterns.md:193 references/common-patterns.md:509 references/rest_best_practices.md:376 references/rest_best_practices.md:491 references/rest_best_practices.md:648 references/rest_best_practices.md:658 references/rest_best_practices.md:659 references/rest_best_practices.md:711 references/rest_best_practices.md:720 references/rest_best_practices.md:785 references/rest_best_practices.md:786 references/rest_best_practices.md:787 references/rest_best_practices.md:788 references/versioning-strategies.md:20 references/versioning-strategies.md:21 references/versioning-strategies.md:22 references/versioning-strategies.md:311 references/versioning-strategies.md:316 references/versioning-strategies.md:331 references/versioning-strategies.md:380 references/versioning-strategies.md:381 scripts/api_helper.py:306 scripts/api_helper.py:307 SKILL.md:399 SKILL.md:513
🔑 环境变量 (4)
📁 文件系统访问 (2)
最新一次完成的静态与语义审计未检测到已确认的安全发现。这并不能证明该 Skill 没有副作用。
审计者: codex 查看审计历史 →
分享与引用此报告
分享版本化评估报告、中性徽章、嵌入卡片和引用。Skillstore 只报告证据，不判断该 Skill 是否安全。
复制报告链接
https://skillstore.io/skills/autumnsgrove-api-designer/audits/14?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown 徽章
[](https://skillstore.io/skills/autumnsgrove-api-designer?utm_source=security_passport_badge)HTML 徽章
<a href="https://skillstore.io/skills/autumnsgrove-api-designer?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/autumnsgrove-api-designer/security.svg" alt="Skillstore security assessment" loading="lazy"></a>嵌入卡片
<iframe src="https://skillstore.io/embed/skills/autumnsgrove-api-designer.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>学术引用 (APA · BibTeX · CFF)
APA 引用
AutumnsGrove. (2026). api-designer security audit report (audit version 14) [Author version unspecified]. Skillstore. https://skillstore.io/skills/autumnsgrove-api-designer/audits/14BibTeX 引用
@techreport{autumnsgrove-autumnsgrove-api-designer-2026,
author = {AutumnsGrove},
title = {api-designer security audit report (audit version 14)},
institution = {Skillstore},
year = {2026},
number = {14},
url = {https://skillstore.io/skills/autumnsgrove-api-designer/audits/14},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "api-designer security audit report (audit version 14)"
version: "unspecified"
type: report
authors:
- name: "AutumnsGrove"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/autumnsgrove-api-designer/audits/14"
identifiers:
- type: other
value: "skillstore:autumnsgrove-api-designer:audit:14"
description: "Skillstore immutable audit report identifier"
Skillstore 评分
评分依据 证据置信度: 高 82
架构
85
可维护性
87
内容
71
社区
78
规范符合性
你能构建什么
设计新的服务契约
在开始实现之前，定义 REST 资源、载荷、状态码、分页和错误响应。
规划 API 版本控制和弃用
选择版本控制策略，记录破坏性变更，并为客户端团队准备迁移指导。
创建开发者文档
将端点决策转化为 OpenAPI 大纲、身份验证说明、示例和可读的参考文档。
试试这些提示
设计基础 REST API
为 [product] 设计一个 REST API。包含核心资源、方法、状态码、分页和错误响应。
创建 OpenAPI 大纲
为 [service] 创建一个 OpenAPI 大纲。包含服务器、路径、模式、安全方案和示例响应。
规划身份验证和版本控制
为 [API] 推荐身份验证、授权、速率限制和版本控制。解释权衡和迁移风险。
审查现有 API 契约
审查此 API 契约的一致性、安全性、向后兼容性、错误处理和文档缺口：[details]。
最佳实践
- 在编写端点细节之前，先从资源、权限、数据所有权和错误行为开始。
- 保持 OpenAPI 示例、身份验证规则和版本控制说明与实现变更同步。
- 在公开发布前，与安全、平台和客户端团队一起审查生成的规范。
避免
- 不要将机密、令牌或 API 密钥放在 URL、日志或公开示例中。
- 不要为了增量可选字段或错误修复而对 API 进行版本控制。
- 不要发布未记录的状态码、不一致的错误或无边界的列表端点。
常见问题
此技能可以创建 OpenAPI 规范吗？
可以。它提供 OpenAPI 结构、示例，以及用于示例规范生成和基础验证的辅助脚本。
它支持 GraphQL 设计吗？
可以。它涵盖类型、查询、变更、关系、分页、解析器和 N+1 预防概念。
它可以选择身份验证策略吗？
可以。它解释 OAuth 2.0、JWT、API 密钥、RBAC、速率限制和常见权衡。
它会替我实现 API 吗？
不可以。它设计契约和文档，但实现仍然在你的应用程序代码中完成。
它可以验证每一条 OpenAPI 规则吗？
不可以。包含的验证器只检查基础结构。请使用专门的 OpenAPI 验证器作为发布门禁。
它对现有 API 有用吗？
可以。它可以审查端点一致性、身份验证缺口、版本控制风险和文档质量。
开发者详情
作者
AutumnsGrove许可证
MIT
Skillstore 修订
r3
版本提示
作者未声明版本。
引用
89edfdc710d0846129dcee6a929477b04f08052c
维护新鲜度
2026/7/24
使用量
34 次下载 · 267 次浏览