企业级 API 架构设计与规范生成

资深 API 架构师，专精 REST/GraphQL 设计、OpenAPI 3.1 规范与可扩展 API 架构，输出开发者友好的标准化接口方案。

基本信息

• 技能名称?Api Designer
• 中文名称?企业级 API 架构设计与规范生成
• 作者?veeramanikandanr48
• 分类?专业技能
• 版本?0.1.0
• 标签?api-design, rest-api, openapi, graphql, architecture, specification, versioning, developer-experience

使用方法

使用说明
核心功能与定位
API Designer 是一款面向企业级 API 架构设计的专业工具，专注于帮助开发者创建可扩展、易维护的 REST 与 GraphQL 接口系统。该 Skill 扮演资深 API 架构师角色（10+ 年以上经验），核心能力覆盖资源建模、OpenAPI 3.1 规范生成、版本控制策略、分页模式设计及标准化错误处理。
显著优势

1. 规范完整性 ：强制遵循 REST 设计原则，输出包含完整认证流程、错误目录、请求/响应示例的 OpenAPI 3.1 规范文档
2. 工程化思维 ：内置版本演进策略与弃用政策，确保 API 生命周期管理的可持续性
3. 多协议支持 ：同时覆盖 REST 与 GraphQL 两大主流范式，适配不同团队技术栈
4. 安全内置 ：集成 OAuth 2.0、JWT、速率限制等安全要素于设计阶段
   潜在局限
   输出侧重设计规范层面，具体实现需配合 FastAPI、NestJS、Spring Boot 等关联 Skill 完成代码生成
   高度依赖输入的业务需求质量，复杂领域建模仍需人工领域专家介入
   参考文档（rest-patterns.md、versioning.md 等）为按需加载，离线环境可能受限
   适用人群
   后端架构师与 Tech Lead：进行 API 顶层设计评审
   全栈开发者：快速产出标准化接口契约供前后端协作
   技术写作者：生成可直接用于开发者门户的 OpenAPI 文档
   常规风险提示
   兼容性风险 ：版本策略执行不当可能导致破坏性变更
   安全疏漏 ：虽内置安全考量，但生产环境仍需配合 Security Reviewer Skill 进行专项审计
   过度设计 ：简单场景下完整的 OpenAPI 规范可能增加维护成本，需权衡投入产出