Swagger2介绍及使用

swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。

• @Api：修饰整个类，描述Controller的作用

• @ApiOperation：描述一个类的一个方法，或者说一个接口

• @ApiParam：单个参数描述

• @ApiModel：用对象来接收参数

• @ApiModelProperty：用对象接收参数时，描述对象的一个字段

• @ApiImplicitParam：一个请求参数

• @ApiImplicitParams：多个请求参数

3、项目中整合Swagger2

==============================================================================

3.1、引入Swagger2依赖

---

io.springfox

springfox-swagger-ui

2.9.2

io.springfox

springfox-swagger2

2.9.2

compile

3.2、编写swgger2配置类代码

---

import com.google.common.base.Predicates;

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.service.ApiInfo;

import springfox.documentation.service.Contact;

import springfox.documentation.spi.DocumentationType;

import springfox.documentation.spring.web.plugins.Docket;

import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**

• Swagger2配置信息

*/

@Configuration

@EnableSwagger2

public class Swagger2Config {

@Bean

public Docket webApiConfig(){

return new Docket(DocumentationType.SWAGGER_2)

.groupName(“webApi”)

.apiInfo(webApiInfo())

.select()

//只显示api路径下的页面

.paths(Predicates.and(PathSelectors.regex(“/api/.*”)))

.build();

}

@Bean

public Docket adminApiConfig(){

return new Docket(DocumentationType.SWAGGER_2)

.groupName(“adminApi”)

.apiInfo(adminApiInfo())

.select()

//只显示admin路径下的页面

.paths(Predicates.and(PathSelectors.regex(“/admin/.*”)))

.build();

}

private ApiInfo webApiInfo(){

return new ApiInfoBuilder()

.title(“网站-API文档”)

.description(“本文档描述了网站微服务接口定义”)

.version(“1.0”)

最后

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此收集整理了一份《2024年Web前端开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点！不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门！

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！
是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门！**

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！