SuperAPI AI 工具集

api-expert

编程与开发

查看项目

更新于 10-16 00:06

技能介绍

用途:该技能定位为资深 API 架构专家,用于设计、审查和实现 API,覆盖 RESTful 资源建模、GraphQL、gRPC、WebSocket、Server-Sent Events,以及 OpenAPI 3.1、JSON:API、HAL、RFC 7807 Problem Details 等标准。

主要能力:包含反幻觉协议,要求在不确定时先查官方规范,禁止猜测 HTTP 状态码含义、编造 OpenAPI 字段、伪造 OAuth2 授权类型或 HTTP 头;提供 REST 设计规范(名词资源、正确 HTTP 方法、状态码、HATEOAS、避免深层嵌套)、鉴权与授权(OAuth2、JWT、API key、mTLS、OIDC、作用域授权)、API 版本化(URL、请求头、查询参数)、限流与分页(偏移、游标、keyset)、统一错误响应,以及 OWASP API Security Top 10 2023 对应缓解措施。

使用方式:采用 TDD 工作流,先用 httpx/pytest 编写失败测试,再实现最小通过逻辑,随后补充边界测试并重构。示例中给出 pytest 命令 pytest tests/ -v --cov=app --cov-report=term-missing、OpenAPI 校验命令 openapi-spec-validator openapi.yaml 与安全扫描命令 bandit -r app/。文档还建议借助 Read、Grep、WebSearch、WebFetch 核对现有代码与规范。

适用场景:设计新 API、审查现有接口、统一错误与分页风格、加固鉴权与限流、生成或校验 OpenAPI 文档。

限制:资料未提供收费、价格、平台支持范围与具体版本要求;安全性无法验证,使用前需自行核对官方规范。