接口设计规范

简介: 该文档介绍了需求分析和接口设计的步骤。首先,通过原型文档和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工具测试接口,需知道明确的接口信息

目录
相关文章
|
Java 数据处理
接口设计规范
接口设计规范
694 2
|
8月前
|
监控 安全 网络协议
Hyper V上网实战:多虚拟机网络环境配置
在Hyper-V环境中配置多虚拟机网络以实现上网功能,需完成以下步骤:1. 确认Hyper-V安装与物理网络连接正常;2. 配置虚拟交换机(外部、内部或专用)以支持不同网络需求;3. 设置虚拟机网络适配器并关联对应虚拟交换机;4. 验证虚拟机网络连接状态;5. 根据场景需求优化多虚拟机网络环境。此外,还需注意网络隔离、性能监控及数据备份等事项,确保网络安全稳定运行。
|
设计模式 Java 关系型数据库
【阿里规约】阿里开发手册解读——命名规范篇
本文中所有代码命名规范遵循《阿里规约》,从包名、类名、变量名等角度展开,详细阐述测试类、枚举类、数组、布尔型变量、方法等元素的命名规范。
【阿里规约】阿里开发手册解读——命名规范篇
|
缓存 监控 API
微服务架构下RESTful风格api实践中,我为何抛弃了路由参数 - 用简单设计来提速
本文探讨了 RESTful API 设计中的两种路径方案:动态路径和固定路径。动态路径通过路径参数实现资源的 CRUD 操作,而固定路径则通过查询参数和不同的 HTTP 方法实现相同功能。固定路径设计提高了安全性、路由匹配速度和 API 的可维护性,但也可能增加 URL 长度并降低表达灵活性。通过对比测试,固定路径在性能上表现更优,适合微服务架构下的 API 设计。
249 1
|
Web App开发 JSON JavaScript
vue学习:chrome 中 vuetools 开发插件 的下载、安装
这篇文章介绍了如何在Chrome浏览器中下载、安装并测试Vue.js开发插件——vue-devtools。
3267 0
vue学习:chrome 中 vuetools 开发插件 的下载、安装
|
SQL JSON API
接口设计的18条军规
本文介绍了接口设计的18条最佳实践,包括签名防止数据篡改、加密敏感信息、IP白名单增强安全性、限流保护服务、统一返回值结构、异常统一处理、请求日志记录、幂等性设计、限制请求记录条数、压力测试、异步处理、数据脱敏、完整接口文档、合理使用请求方式、利用请求头传递参数、设计批量操作接口和职责单一原则。这些规则旨在确保API接口的安全、稳定、高效和易于维护。
229 3
|
小程序
微信小程序APPID的两种查看方法
查看微信小程序APPID的两种方法:1) 在小程序内点击右上角“...”,进入查看页面,点击“更多资料”查看;2) 登录微信公众平台([https://mp.weixin.qq.com/](https://mp.weixin.qq.com/)),进入【设置】查看“账号信息”。
13388 1
|
Ubuntu Linux C语言
【opencv】opencv在windows和linux的应用
【opencv】opencv在windows和linux的应用
|
SpringCloudAlibaba 监控 Java
SpringCloud Alibaba微服务-- Sentinel的使用(保姆级)
SpringCloud Alibaba微服务-- Sentinel的使用(保姆级)