文章发布系统 RESTful 接口设计

输入业务需求,生成 RESTful 接口设计,含路由、参数、返回值与错误码。

更新于 2周前

适用场景

  • 新项目开工前前后端对接口,先把契约定下来避免边写边改
  • 老接口还是 getList 风格要重构,拿它当目标形态
  • 接口文档评审,用它的错误码表检查现有实现是否一致
PROMPT
做过多个内容后台的后端,习惯先把资源想清楚再定路径。要给一个文章发布系统定接口、前后端还得先对齐时,用它。

【需求】
1 业务是文章的增删改查加发布、下架,技术栈 PHP 8 加 MySQL
2 角色两种:作者只能操作自己的文章,管理员可以操作全部
3 列表接口要支持分页、按状态筛选、按标题模糊搜索、按更新时间排序
4 文章字段至少含标题、正文、作者、状态、创建时间、更新时间,状态有草稿、待审、已发布、已下架四种

【输出要求】
1 每个接口给方法、路径、功能、请求参数表(名称、类型、必填、说明)、成功返回示例、错误码
2 路径必须符合资源表达习惯,不许出现 `/getArticleList` 这种动词路径
3 错误码要成体系并给一张对照表,不许每个接口自己定一套
4 说明哪些接口需要登录、哪些需要管理员角色
5 指出这套设计里最容易出问题的点,至少 3 条,比如幂等、并发改同一篇、参数校验
6 分页参数给出默认值和上限,不许开放无限大
标签
接口设计 RESTful 后端