给swagger的接口添加描述

swgger非常便于前后端分离开发，通过给swagger添加描述就可以实现前后端共同的开发接口，以下介绍如何给swagger的接口添加描述。

一.创建实体，并在实体和属性上使用@ApiModel()、@ApiModelProperty()注解。

注解的具体文档请参考https://blog.csdn.net/dejunyang/article/details/89527348

1.1 工作者实体

//工作者实体
import com.alibaba.fastjson.annotation.JSONField;
import com.baomidou.mybatisplus.annotations.TableField;
import com.baomidou.mybatisplus.annotations.TableId;
import com.baomidou.mybatisplus.annotations.TableName;
import com.baomidou.mybatisplus.enums.IdType;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import javax.validation.constraints.NotEmpty;
import java.util.Date;
import java.util.List;@Data
@TableName("XXW_WORKER_T")
@ApiModel("工作者实体")
public class XxwWorkerT extends FieldFillBean {/*** 主键*/@TableId(value = "XXW_WORKER_ID", type = IdType.UUID)@ApiModelProperty("主键id")private String xxwWorkerId;/*** 姓名*/@TableField("NAME")@NotEmpty(message = "姓名不能为空")@ApiModelProperty("姓名")private String name;/*** 年龄*/@TableField("AGE")@ApiModelProperty("年龄")private Integer age;/*** 出生日期*/@TableField("BIRTHDAY")@JSONField(format = "yyyy-MM-dd")@ApiModelProperty("出生日期")private Date birthday;@ApiModelProperty("代码表")private DemoTable demoTable;@ApiModelProperty("用户表吧")private List<UserBa> userBas;
}

1.2 代码表实体

//代码表实体
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
@Data
@ApiModel("demo表")
public class DemoTable {@ApiModelProperty("表名称")private String tableName;@ApiModelProperty("表代码")private String tableCode;
}

1.3 用户吧实体

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;@Data
@ApiModel("userBa表")
public class UserBa {@ApiModelProperty("用户名称")private String userBaName;@ApiModelProperty("用户代码")private String userBaCode;
}

二、controller使用resultful风格请求

2.1 post请求

2.1.1 controller实现方式

  /*** 增加一个新的工作者*/@ApiOperation("增加一名新的工作者")@RequestMapping(value = {"/addOneWorker"},method = {RequestMethod.POST})public ResponseData addOneWorker(@Valid @RequestBody XxwWorkerT xxwWorkerT){this.xxwWorkerTService.addOneWorker(xxwWorkerT); //新增接口return SUCCESS_TIP;}

2.1.2 效果演示

2.2 get请求

2.2.1 controller实现方式

 /*** 条件分页查询工作者名单*/@GetMapping(value = "/selectWorkerListByPage")@ApiImplicitParams({@ApiImplicitParam(name = "pageSize", value = "每页显示数量", required = false, dataType = "Integer", example = "10", paramType = "query"),@ApiImplicitParam(name = "pageNo", value = "第几页，从1开始", required = false, dataType = "Integer", example = "1", paramType = "query"),@ApiImplicitParam(name = "name", value = "姓名", required = false, dataType = "String", paramType = "query"),@ApiImplicitParam(name = "age", value = "年龄", required = false, dataType = "Integer", paramType = "query"),@ApiImplicitParam(name = "birthday", value = "出生日期", required = false, dataType = "String", paramType = "query")})@ResponseBody@ApiOperation(value = "条件分页查询工作者名单", notes = "条件分页查询工作者名单")public RawResponseQi selectWorkerListByPage(@RequestParam(required = false) String name,@RequestParam(required = false) Integer age,@RequestParam(required = false) String birthday) {return xxwWorkerTService.selectWorkerListByPage(name, age, birthday);}

2.2.2 效果演示

2.3 put请求

2.3.1 controller实现方式

 /*** 更新工作者信息*/@PutMapping(value = "/updateOneWorker")@ApiOperation(value = "修改一名工作者信息", notes = "修改一名工作者信息")public ResponseData updateOneWorker(@Valid @RequestBody XxwWorkerT xxwWorkerT){this.xxwWorkerTService.updateOneWorker(xxwWorkerT);return SUCCESS_TIP;}

2.3.2 效果演示

2.4 delete请求

2.4.1 delete实现方式

@DeleteMapping(value = "/deleteOneWorker")@ApiOperation(value = "删除一名新的工作者", notes = "删除一名新的工作者")public ResponseData deleteOneWorker(@RequestParam(value = "id",required = true) String id){this.xxwWorkerTService.deleteOneWorker(id);return SUCCESS_TIP;}

2.4.2 效果演示

给swagger的接口添加描述相关推荐

Popular MVC框架swagger+knif4j接口文档工具使用示例
Popular MVC框架swagger接口文档工具使用示例简介此项目介绍如何使用popularmvc内置的swagger+knife4j实现简单易用的实时API文档,支持在线调试接口! 此项目只 ...
基于 abp vNext 和 .NET Core 开发博客项目 - 再说Swagger，分组、描述、小绿锁
基于 abp vNext 和 .NET Core 开发博客项目 - 再说Swagger,分组.描述.小绿锁 https://github.com/Meowv/Blog 在开始本篇正文之前,解决一个 @ ...
idea swagger生成接口文档_Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据...
一.简介在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
Swagger ui接口自动化批量漏洞测试
目录 Swagger介绍 postman 导入Swagger Api 设置Environment 代理设置批量自动化测试结合xray Swagger介绍 Swagger 是一个用于生成.描述和调用 ...
实体类接口_spring-boot-route（五）整合Swagger生成接口文档
目前,大多数公司都采用了前后端分离的开发模式,为了解决前后端人员的沟通问题,后端人员在开发接口的时候会选择使用swagger2来生成对应的接口文档,swagger2提供了强大的页面调试功能,这样可以有 ...
[Golang梦工厂]一个小项目带你学会GIN框架、JWT鉴权、swagger生成接口文档，看这一篇就够了
前言哈喽,大家好,我是asong,这是我的第八篇原创文章.听说你们还不会jwt.swagger,所以我带来一个入门级别的小项目.实现用户登陆.修改密码的操作.使用GIN(后台回复Golang梦工厂: ...
swagger学习日记1 swagger测试接口时传入参数的类型问题
问题现象: 今天在学习swagger做接口api说明的时候,出现了一个一直解决不了的问题,而且网上搜了很久,都找不到任何相似的问题和解决方法: 当用swagger测试一个需要传入(Integer数据类 ...
Jmeter(一)http接口添加header和cookie --转载
Jmeter(一)http接口添加header和cookie HTTP信息头管理器在Jmeter的使用过程中起着很重要的作用,通常我们在通过Jmeter向服务器发送http请求(get或者post)的 ...
给SQL数据库表和字段添加描述信息
在创建数据库表时,有时怕忘记了字段的作用,要给表的字段加上一些说明文字.而以前要经常切换到表的设计方式去添加一些说明文字,这样总觉得比较麻烦. 刚好查了一下数据库的联机丛书发现还有这样的命令,现在我把 ...

给swagger的接口添加描述

给swagger的接口添加描述相关推荐

最新文章

热门文章