接口设计规范

简介: 该文档介绍了需求分析和接口设计的步骤。首先,通过原型文档和PRD理解业务需求,如有必要需与产品经理深入沟通。其次,设计接口时需考虑四要素:请求路径(按模块命名,英文)、请求方式(GET, POST, PUT, DELETE,遵循RESTful风格)、请求参数(路径参数和请求体参数)和响应参数(统一格式,通常包含状态码、消息和数据)。最后,提到了接口测试,推荐使用Postman、Apifox、Swagger或Knife4j等工具进行测试。

1. 需求分析

在接收到任务之后,我们需要查看任务涉及到的模块,需要快速熟悉业务,熟悉业务的参考就是原型文档和PRD文档,我们接下来要开发的床位相关的接口,那么就详细查看床位相关的原型图即可。

特殊情况,新需求可能会没有原型图,这时就需要跟产品经理要多沟通,直至搞明白需求为止

2. 接口四要素

搞明白需求之后,我们下面就可以来设计接口了,一个接口包含了四个基本要素,分别是:请求路径、请求方式、接口入参(请求参数)、接口出参(响应参数)

  • 请求路径 命名:以模块名称进行区分(英文)
  • 请求方式(需要符合restFul风格)
  • 查询  GET
  • 新增 POST
  • 修改 PUT
  • 删除 DELETE
  • 接口入参(请求参数)
  • 路径参数
  • 问号传参---->后端形参接收
  • path传参---->后端PathVariable注解接收
  • 请求体参数
  • 前端:json对象
  • 后端:对象接收,DTO
  • 接口出参(响应参数)
  • 统一格式 {code:200,msg:"成功",data:{}}
  • 数据封装,一般为VO
  • 敏感数据过滤
  • 整合数据

image.png

3. 接口测试

测试工具有很多,以下几个是比较常见的接口测试工具

  • Postman
  • Apifox
  • Swagger   在线接口文档
  • Knife4j     对swagger的增强,可生成离线接口文档

使用postman或者apifox工具测试接口,需知道明确的接口信息

目录
相关文章
|
SQL 前端开发 安全
详细介绍前后端分离必备的接口规范,包括命名规范、参数规范、错误处理规范等
详细介绍前后端分离必备的接口规范,包括命名规范、参数规范、错误处理规范等
2408 1
|
22天前
|
移动开发 编解码 JavaScript
MediaSource 规范
【10月更文挑战第26天】MediaSource 规范是 HTML5 中用于处理媒体流的一项重要技术
|
5月前
|
Java 数据处理
接口设计规范
接口设计规范
241 2
|
6月前
|
XML JSON API
前后端分离的接口设计规范
前后端分离的接口设计规范
|
存储 JSON NoSQL
|
算法 IDE 程序员
代码编写规范
代码编写规范
|
Go 开发工具 git
一文掌握 godoc的使用与规范
一文掌握 godoc的使用与规范
1123 0
|
存储 消息中间件 SQL
数据开发流程及规范
P0\P1级别问题在规定时间内无法解决的,需要该问题的研发同学在问题comments内说明无法在规定时间内解决的合理的解释,并告知该问题具体的解决时间点同时邮件说明。
数据开发流程及规范
|
SQL 负载均衡 Java
怎么设计一个高质量的接口API设计
什么是幂等性?对于同一笔业务交易,不管调用多少次,只会成功处理一次。二、幂等性设计我们转账业务为例,来说明一下这个问题,转账接口一定要做到幂等性,否则会出现重复转账的问题。调用转账接口从A中转100元资金给B,参数中会携带业务流水号biz_no和源账户A,目的账户B,和转账金额100,业务流水号biz_no是唯一的。转账接口实现有以下实现方式。
|
监控 安全 Linux
下一篇
无影云桌面