Springboot集成使用swagger2

1、jar包引入：

        <dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version></dependency>

2、编写启动类：

/*** 生成Api文档*/
@Configuration
@EnableSwagger2
//是否开启swagger，可根据自己需要要不要开启，可以配置到配置文件中，也可以不配置这个注解
@ConditionalOnProperty(name = "swagger.enable",  havingValue = "true")
public class Swagger2Config {/*** 通过createRestApi函数创建Docket的Bean之后，* apiInfo()用来创建该Api的基本信息（这些基本信息会展现在文档页面中）。* select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现，* 本例采用指定扫描的包路径来定义，* Swagger会扫描该包下所有Controller定义的API，* 并产生文档内容（除了被@ApiIgnore指定的请求）。** @return*/@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()// 改成自己要扫描的包路径.apis(RequestHandlerSelectors.basePackage("com.group.lxm.ceshi")).paths(PathSelectors.any()).build();}/*** 用来创建该Api的基本信息（这些基本信息会展现在文档页面中）** @return*/private ApiInfo apiInfo() {return new ApiInfoBuilder()// 页面标题.title("CargoReportServer RESTful-APIs")// 页面描述.description("CargoReportServer项目api文档,POST添加,GET获取,PUT修改,DELETE删除")// 创建人信息.contact(new Contact("lxm", "", "****************"))// 版本信息.version("1.0").build();}
}

3、使用：

书写接口的时候，正确使用swagger相关的注解：

@Api()：用在请求的类上，表示对类的说明，也代表了这个类是swagger2的资源

@ApiOperation()：用于方法，表示一个http请求访问该方法的操作

@ApiModel()：用于响应实体类上，用于说明实体作用

@ApiModelProperty：用在属性上，描述实体类的属性

@ApiImplicitParams：用在请求的方法上，包含多@ApiImplicitParam

@ApiImplicitParam：用于方法，表示单独的请求参数

@ApiParam()：用于方法，参数，字段说明表示对参数的要求和说明

@ApiResponses：用于请求的方法上，根据响应码表示不同响应

@ApiResponse：用在请求的方法上，表示不同的响应

@ApiIgnore()：用于类或者方法上，不被显示在页面上

@Profile({"dev", "test"})：用于配置类上，表示只对开发和测试环境有用

eg:

4、访问：

访问项目路径+swagger-ui.html 即可查看所有的我们项目中的接口，选择要测试的接口，点击try it out即可访问接口。

Springboot集成使用swagger2相关推荐

springboot集成swagger2测试接口
springboot集成swagger2测试接口 1.需要的依赖 2.开始编写一个swagger2 3.演示效果图片 1.需要的依赖 <dependency><groupId> ...
springboot集成swagger2多模块中文配置详细步骤，解决集成mybatis或mybatis-plus无法正常使用问题
springboot集成swagger2多模块中文配置详细步骤,解决集成mybatis或mybatis-plus无法正常使用问题参考文章: (1)springboot集成swagger2多模块中文配 ...
13.9 SpringBoot集成Swagger2中遇到的问题
13.9 SpringBoot集成Swagger2中遇到的问题我们在使用SpringBoot集成Swagger2中,访问:http://127.0.0.1:8188/swagger-ui.html ...
springboot集成swagger2构建RESTful API文档
在开发过程中,有时候我们需要不停的测试接口,自测,或者交由测试测试接口,我们需要构建一个文档,都是单独写,太麻烦了,现在使用springboot集成swagger2来构建RESTful API文档,可 ...
[Swagger2]SpringBoot集成Swagger
SpringBoot集成Swagger 引入依赖 <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 ...
springboot集成swagger2，构建优雅的Restful API
springboot集成swagger2,构建优雅的Restful API 转载请标明出处: 原文首发于:https://www.fangzhipeng.com/springboot/2017/07/ ...
SpringBoot集成Swagger2自动生成友好的RestApi测试页面及文档
springBoot集成swagger2 水煮鱼又失败了 https://www.jianshu.com/p/002ce2f26103 1 背景 springBoot作为微服务首选框架,为其他服务提供 ...
【快速上手系列】使用Springboot集成Swagger2的简单使用测试
[快速上手系列]使用Springboot集成Swagger2的简单使用测试简介 Swagger2是为了解决企业中接口(api)中定义统一标准规范的文档生成工具. 尤其是前后端分离时对一些业务接口也不 ...
SpringBoot集成Swagger2
SpringBoot集成Swagger2 刚开始用2.0.2.RELEASE版本的SpringBoot去继承2.7.0版本的springfox-swagger2一直出现请求下面这种情况,就是在启动Sp ...

Springboot集成使用swagger2

Springboot集成使用swagger2相关推荐

最新文章

热门文章