接口设计规范

简介: 该文档介绍了需求分析和接口设计的步骤。首先,通过原型文档和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 前端开发 安全
详细介绍前后端分离必备的接口规范,包括命名规范、参数规范、错误处理规范等
详细介绍前后端分离必备的接口规范,包括命名规范、参数规范、错误处理规范等
2538 1
|
存储 设计模式 人工智能
规范:前端代码开发规范
规范:前端代码开发规范
1623 0
|
2月前
|
移动开发 编解码 JavaScript
MediaSource 规范
【10月更文挑战第26天】MediaSource 规范是 HTML5 中用于处理媒体流的一项重要技术
|
7月前
|
Java 数据处理
接口设计规范
接口设计规范
286 2
|
8月前
|
XML JSON API
前后端分离的接口设计规范
前后端分离的接口设计规范
|
存储 JSON NoSQL
|
程序员
代码的规范
代码的规范
177 0
|
算法 IDE 程序员
代码编写规范
代码编写规范
|
Go 开发工具 git
一文掌握 godoc的使用与规范
一文掌握 godoc的使用与规范
1182 0
|
缓存 监控 架构师
开发流程规范
这是近期在公司做的一次分享,这几年的互联网开发,算比较幸运,团队一直践行完善这套规范,没有太多的阻碍,得益于公司整体氛围,以及团队对规范和写文档的不排斥,形成了良好的开发习惯 在这次分享后,发现好些大V也在谈规范,写文档,估计是前段时间阿里又发布了开发手册(华山版),借鉴于一下,对一些细节做些补充,整理出来
2428 0
开发流程规范