swagger的了解和拓展

swagger的前言了解

swagger是一个专门开发api文档和接口文档；
就是前后端的交互的平台；
即就是当一个前段在做某一个模块的时候需要发送一个什么样的请求，
而后端则需要接受一个什么的请求和请求方式等；

使用swagger前提是必须前后端分离开发；

关于openAPI的说明

其中rest是指的是get是查询请求，post是新增请求，put是修改请求，delete 是删除请求；
其中，yaml和json则程序员和计算机都可以进行阅读；

swggerfox的生成

swagger的入门案例

首先创建一个maven工程

在pom文件里面添加一些依赖

然后创建一个contoller类

这是一个启动类

swagger的配置

swagger的注解

关于swagger的代码注解
关于@Api注解说明

在相应的代码上显示相应的信息

关于@ApiOperation注解的说明

关于@ApiParam的注解说明，这是一个参数注解；

其中name属性指的是参数名称，value指的是参数的描述，required指的是这些参数是不是必要的默认是false；

关于@ApiIgnore注解的说明；

那么这个时候这个get请求方式就会没有，只有post请求方式；

关于swagger的@ApiImplicitPram注解的说明；
其中name是该方法的名字，value是指的是描述，required是指的是是否必须的，paramtype是指的是参数类型，datatype是指的是数据类型；

关于swagger的@ApiImplicitPrams的注解的说明；

关于@ApiModel和@apimodelproperty的注解的说明；
其中，在@ApiModel的属性说明，value是起的名字，description的属性指的是描述；
@apimodelproperty的属性说明：value是描述，name是名称，required是否为必须的，
example加一个实例案例，hidden属性是不是隐藏的 ；

这是在pojo的实体类上写

因为需要将这个实体类的进行返回那么，就需要在controller层写方法

执行结果