一个好的项目,需要有一个好的文档;
项目中的成员有前端角色,主要负责UI交互,从后端获取数据;另一个角色是后端,也就是服务器端,负责处理业务逻辑,提供前端需要的数据接口,前端人员如何知道后端提供的接口呢?
Swagger , 使用Swagger生成服务器接口文档,并能实现接口功能测试;
Swagger是一组围绕OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录和使用REST APIs;
主要的Swagger 工具包括:
本课程使用PDT4j教学法,以案例驱动教学,让大家快速掌握Swagger;
3-1 @Api控制器逻辑分类
3-2 @ApiOpertation描述接口作用
3-3 @ApiOpertation其他属性
3-4 @ApiOperation的其他属性2
3-5 @ApiParam描述接口参数
3-6 @ApiImplicitParam功能介绍
3-7 @ApiImplicitParam的dataType和paramType
3-8 @ApiImplicitParam的defaultValue
3-9 @ApiImplicitParam的allowableValue
3-10 @ApiModel描述实体类
3-11 @ApiModelProperty描述实体类属性
3-12 @ApiModelProperty其他属性
3-13 @ApiResponse接口返回值
3-14 @ApiResonse的其他属性
3-15 @ApiIgnore忽略接口
获取步骤