¥
立即购买

根据用户指定的资源类型、操作类型及认证级别,设计符合RESTful规范的API端点,包含URL模式、HTTP方法、请求/响应格式及认证要求,生成可直接用于开发的标准化接口设计文档,支持快速迭代和扩展。

免费试用多模型对比变量与模板化文本输出
完整提示词模板
¥25.00

提示词变量

正在加载表单组件...

提示词生成结果

📝
暂无试用结果

变量说明

  • 资源类型
    API对应的数据资源类型
    示例:“用户”
  • 操作类型
    端点支持的操作类型
    示例:“Create”
  • 认证级别
    API访问权限控制级别
    示例:“公开”
  • 请求/响应格式
    接口数据交换格式
    示例:“JSON”

使用场景案例

  • 文章端点设计
    为“知识库文章”生成REST文档:/v1/articles、/v1/articles/{id};所有端点需认证;支持分页、搜索与标签筛选;POST/PUT字段title、body、tags、author_id;返回示例含状态码与错误结构。
  • 商品端点设计
    为“商品目录条目”生成端点:/v1/products、/v1/products/{id};管理员创建/更新;读支持分类、价格区间、排序;请求含name、sku、price、stock、status;响应含库存与分页元数据,含鉴权说明。
  • 任务端点设计
    为“项目任务与子任务”生成端点:/v1/projects/{project_id}/tasks、/v1/tasks/{id}/subtasks;公开读取,支持状态、执行人筛选与排序;POST含title、description、due_date、assignee_id;附XML请求/响应样例与分页规则。