前后端分离开发接口文档配置
目录:
开发流程
项目中接口服务器配置
规范
数据格式
响应内容规范
一 开发流程
后端编写和维护接口文档
后端开发接口
前端根据接口渲染
前后端联调
二 springboot项目搭建接口服务器
API文档生成工具: Swagger+knife4j2.1 加入pom依赖
<!-- swagger依赖配置 --> <dependency> <groupId>io.swagger</groupId> <artifactId>swagger-models</artifactId> <version>${swagger.core.version}</version> </dependency> <dependency> <groupId>io.swagger</groupId> <artifactId>swagger-annotations</artifactId> <version>${swagger.core.version}</version> </dependency> <!-- Swagger --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>${swagger.fox.version}</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>${swagger.fox.version}</version> </dependency> <!-- knife4j --> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-ui</artifactId> </dependency>
2.2 类上加入注解 @EnableSwagger2
三 规范
接口返回数据即展示,前端只做渲染处理
渲染逻辑禁止跨多个接口调用
请求响应的数据格式尽量简单
四 数据格式
请求数据格式get和post
响应数据格式 code和data两个必要参数
日期格式JSON数据传输中一律使用字符串
下拉框、复选框、单选框
后端判断逻辑是否选中
isSelect来标记是否选中