SuperAPI AI 工具集

api-design

编程与开发

查看项目

更新于 10-16 01:08

技能介绍

用途:让 AI 智能体设计生产级 RESTful API,遵循无状态、统一接口、基于资源的 URI 等 REST 约束,产出端点定义、请求/响应模式与 OpenAPI 文档。

主要能力:识别资源与关系(一多、多对多),避免动词式端点;为资源定义 CRUD 端点并选对 HTTP 方法(GET 安全幂等、POST 创建非幂等、PUT 全量替换、PATCH 部分更新、DELETE 删除);设计请求体、响应载荷与查询参数,统一字段命名与错误响应封装;为列表端点加入游标或偏移分页,支持过滤与排序并返回分页元数据;选择版本策略(URI 路径 /v1、查询参数、Accept 头);生成含路径、模式、安全方案与示例的 OpenAPI 3.0 规范,并记录限流响应头。

支持技术:OpenAPI 3.0/3.1、JSON Schema、AsyncAPI;Express.js、FastAPI、Django REST Framework、Spring Boot、Rails API;Swagger UI、Redoc、Stoplight;Postman、Insomnia、VS Code REST Client、curl。

使用方式:告知应用领域、涉及实体与用户需执行的操作,代理会产出端点定义、请求/响应模式与 OpenAPI 规范,可迭代修改端点、分页或错误格式。可要求对 POST 支持 Idempotency-Key;响应可含 X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset;201 响应可返回 Location 头;可用 ETag/If-Match 处理并发。

限制:仅覆盖 REST API 设计范畴,未提供具体安装命令与收费信息;实际实现与部署依赖所选框架,资料未展开。