狂妄如何在SpringBoot中使用

　　介绍

这篇文章给大家介绍狂妄如何在SpringBoot中使用,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。

<强>依赖

& lt; dependency> 　　,& lt; groupId> io.springfox 　　,& lt; artifactId> springfox-swagger2 　　,& lt; version> 2.7.0 　　& lt;/dependency> 　　& lt; dependency> 　　,& lt; groupId> io.springfox 　　,& lt; artifactId> springfox-swagger-ui 　　,& lt; version> 2.7.0 　　& lt;/dependency>

配置类

import  org.springframework.context.annotation.Bean; 　　import  org.springframework.context.annotation.Configuration; 　　import  springfox.documentation.builders.ApiInfoBuilder; 　　import  springfox.documentation.builders.PathSelectors; 　　import  springfox.documentation.builders.RequestHandlerSelectors; 　　import  springfox.documentation.service.ApiInfo; 　　import  springfox.documentation.service.Contact; 　　import  springfox.documentation.spi.DocumentationType; 　　import  springfox.documentation.spring.web.plugins.Docket;/* * 　　,*大摇大摆的配置类 　　,* @author 陈加兵 　　,* 　　,*/@ configuration 　　public  class  SwaggerConfig {/* * 　　,*创建用户API文档 　　,* @return 　　,*/,@ bean 　　,public  Docket  createRestUserApi () { 　　,return  new 摘要(DocumentationType.SWAGGER_2) 　　,.groupName (“user"), 　　,.apiInfo (apiInfo ()),//api的信息 　　,.select () 　　.apis (RequestHandlerSelectors 　　.basePackage才能(“cn.tedu.mycat.controller")),//添加包扫描 　　,.paths (PathSelectors.any ()) .build (); 　　 　　,}/* * 　　API, *创建信息 　　,*/,private  ApiInfo  apiInfo () { 　　,return  new  ApiInfoBuilder () 　　,.title (“api文档的标题“),//标题 　　,.description (“api文档的描述“),//描述 　　,.contact(//添加开发者的一些信息 　　new 才能;联系(“爱撒谎的男孩,,,“https://chenjiabing666.github.io",, 　　“18796327106 @163.com"才能).version (“1.0“) .build (); 　　,} 　　 　　}

<>强启动类

在springBoot的启动类上添加一个注解即可配置成功:@EnableSwagger2

<强>访问api的路径
http://ip/projectName/swagger-ui。html

<强>注解说明

<强> @Api

<李>

标注在类上,用来对这个类进行说明的

<李>

如果想要生成文档,必须在类或者接口上标注

<李>

属性如下:

属性名称备注默认值valueurl的路径值
标签如果设置这个值,值的值会被覆盖
描述对api资源的描述
basePath基本路径可以不配置
位置如果配置多个api想改变显示的顺序位置
producesFor示例中,“application/json, application/xml”
consumesFor示例中,“application/json, application/xml”
protocolsPossible价值观:http、https, ws, wss。
授权高级特性认证时配置
隐藏配置为真正的将在文档中隐藏

<强> @ApiOperation

<李>

用在API方法上,对该API做注释,说明API的作用

<李>

不需要多讲,看源码,使用默认的价值属性即可,说明该方法的作用

<李>

属性如下:

valueurl的路径值
标签如果设置这个值,值的值会被覆盖
指出对API资源的描述
响应返回的对象,在文档中点击模型可以获取该配置的内容
responseContainer这些对象是有效的“列表”,“设置”或“地图”。,其他无效
responseReference可以不配置
httpMethod可以接受“得到”、“头”、“后”,“将”,“删除”,“选择”和“补丁”
位置如果配置多个Api想改变显示的顺序位置
中产生同Api的定义
同Api中消耗的定义
协议同Api中的定义
授权同Api中的定义
隐藏是否隐藏,真实或者假,这个可以隐藏后台接口
codehttp的状态码默认200
扩展扩展属性

<强> @ApiImplicitParams

<李>

用来包含Api的一组参数注解,可以简单的理解为参数注解的集合声明

<李>

很重要,这个注解其中包含接口入参的详细说明

<李>

内容是集合

<强> @ApiImplicitParam

用在@ApiImplicitParams注解中,也可以单独使用,说明一个请求参数的各个方面

详细的属性使用说明如下:

狂妄如何在SpringBoot中使用