SuperAPI AI 工具集

api-design

编程与开发

查看项目

更新于 10-16 05:29

技能介绍

用途

API Design 是一个用于设计 RESTful API 端点的技能,属于 sunnypatneedi/claude-starter-kit。它面向需要从零规划或梳理 RESTful 接口的场景,通过结构化的步骤引导完成 API 设计,并输出可供后续使用的接口文档。

主要能力

该技能围绕以下环节展开:

  • 需求梳理:明确资源对应的实体、所需操作(CRUD 及其他)、资源之间的关系,以及 API 的调用方。
  • 端点设计:为每个操作定义 URL 结构,包括资源路径(使用名词、复数形式)、参数放置位置,以及用于过滤和排序的查询参数。
  • HTTP 方法选择:GET 用于读取,POST 用于创建,PUT/PATCH 用于更新,DELETE 用于删除。
  • 请求格式定义:包括请求体 schema、必填与可选字段、校验规则。
  • 响应格式定义:包括成功响应 schema、列表的分页结构、错误响应格式。
  • 状态码规范:2xx 表示成功,4xx 表示客户端错误,5xx 表示服务端错误。
  • 文档生成:生成 OpenAPI/Swagger 规范,包含端点描述、参数定义、schema 定义以及请求/响应示例。
  • 最佳实践检查:验证设计是否符合 RESTful 约定、命名是否一致、状态码是否恰当,以及是否考虑了安全因素。

使用方式

该技能以引导式对话的形式工作。使用者提供需求信息(资源、操作、关系、调用方),技能据此逐步产出端点设计、请求与响应格式、状态码方案,并生成 OpenAPI/Swagger 文档,最后执行最佳实践检查。具体调用方式与安装命令在现有资料中暂未提供。

适用场景

  • 需要为某个实体设计 RESTful 接口时。
  • 需要统一多个端点的命名、状态码与响应结构时。
  • 需要生成 OpenAPI/Swagger 文档时。
  • 需要在设计阶段对照 RESTful 约定与安全注意事项进行自查时。

限制

现有资料未提供该技能的具体安装方式、运行环境要求、支持的平台、是否收费及价格等信息,这些内容暂未提供。