Swagger2的配置教程

首先新建一个springboot项目，然后在pom文件中导入swagger的相关依赖，分别是以下两个：

Springfox Swagger2

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version>
</dependency>

Springfox Swagger UI

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version>
</dependency>

也可以进入maven官网自行下载其他版本的swagger依赖，maven官方地址如下：

jMaven Repository: springfox (mvnrepository.com)https://mvnrepository.com/search?q=springfoxhttps://mvnrepository.com/search?q=springfox

点击进入maven官网，搜索springfox-swagger即可找到

导入相关依赖之后，要想使用Swagger，还需要对Swagger进行配置，在项目中建立一个config包，包下建立一个SwaggerConfig配置类来对Swagger进行配置，如下：

在SwaggerConfig类上面写上注解@Configuration和@EnableSwagger2，其中@Configuration
表示这是一个配置类；而@EnableSwagger2注解来启用Swagger；此时Swagger已经可以使用了，但是都是较原始的内容显示。

启动项目，如果springboot版本太高就可以会抛出异常，建议降低版本，我后面就是把springboot版本降到2.5.6就可以启动了。启动之后访问http://localhost:8080/swagger-ui.html

再对swagger进行下一步的配置，因为Swagger实例Bean是Docket，所以必须通过配置Docket实例来配置Swaggger。

package com.hu.SpringBoot01.config;import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
import java.util.List;@Configuration //说明这是一个配置类
@EnableSwagger2//该注解开启Swagger2
public class SwaggerConfig {@Beanpublic Docket createRestApi() {//添加head参数配置startParameterBuilder tokenPar = new ParameterBuilder();List<Parameter> pars = new ArrayList<>();tokenPar.name("Authorization").description("令牌")//请求头，测试token时可以用到.modelRef(new ModelRef("string")).parameterType("header").required(false).build();pars.add(tokenPar.build());return new Docket(DocumentationType.SWAGGER_2).groupName("webApi").apiInfo(webApiInfo()).select()//扫描的路径包,会将包下的所有被@Api标记类的所有方法作为api.apis(RequestHandlerSelectors.basePackage("com.hu.SpringBoot01.controller")).paths(PathSelectors.any())//所有接口.build().globalOperationParameters(pars);}private ApiInfo webApiInfo() {return new ApiInfoBuilder().title("新生入学后台管理系统接口文档").description("Swagger2后台管理系统在线文档").contact(new Contact("胡雁南","localhost:8080/swagger-ui.html","279186856@qq.com")).version("2.1").build();}
}

此时swagger就可以正常使用了，访问http://localhost:8080/swagger-ui.html

Swagger2的配置教程相关推荐

Swagger2简单使用教程
Swagger2简单使用教程 1.简介 Swagger是为了解决企业中接口(api)中定义统一标准规范的文档生成工具.很多采用前后端分离的模式,前端只负责调用接口,进行渲染,前端和后端的唯一联系, ...
centos7 mysql workbench_centOS下mysql workbench安装配置教程
本文为大家分享了mysql workbench安装配置教程,供大家参考,具体内容如下 step0:安装mysql 在按照workbench之前,先安装mysql.指令是 yum install mys ...
阿里云服务器ECS Ubuntu16.04 初次使用配置教程(图形界面安装)
阿里云服务器ECS Ubuntu16.04 初次使用配置教程(图形界面安装) 2019-01-23 22:55:50 laugh12321 阅读数 851更多分类专栏: ECS Ubuntu 版权声 ...
交换机配置软件crt安装_非常详细的锐捷二层交换机配置教程，适合新手小白
笔者上一篇文章写了关于锐捷三层交换机配置教程,但是这只是核心的配置,还不能搭建一个完整的企业网络.那么这一篇就来讲一下锐捷的二层交换机配置,比起三层交换机的配置,二层交换机配置就非常简单了.同样,今天 ...
Mac下Android studio 之NDK配置教程(一)
Mac下Android studio 之NDK配置教程(一) 1.概述近期项目全线转移到Mac下使用使用Android studio开发. 遇到关键代码封装到 ***native***层,此时在wi ...
Kali Linux常用服务配置教程获取IP地址
Kali Linux常用服务配置教程获取IP地址下面以Kali Linux为例,演示获取IP地址的方法 (1)设置网络接口为自动获取IP地址.在Kali Linux的收藏夹中单击图标,将显示所有的程 ...
Kali Linux常用服务配置教程启动DHCP服务
Kali Linux常用服务配置教程启动DHCP服务通过前面的介绍,DHCP服务就配置好了.接下来,用户就可以使用该服务器来获取IP地址了.下面将对前面配置的服务进行测试. 1.启动DHCP服务如 ...
Kali Linux常用服务配置教程安装及配置DHCP服务
Kali Linux常用服务配置教程安装及配置DHCP服务在Kali Linux中,默认没有安装DHCP服务.下面将介绍安装并配置DHCP服务的方法. 1.安装DHCP服务在Kali Linux中 ...
KaliLinux常用服务配置教程DHCP服务工作流程
KaliLinux常用服务配置教程DHCP服务工作流程 DHCP服务工作流程如图1.1所示. 具体的工作流程如下所示: (1)DHCP客户端以广播的方式发出DHCP Discover报文. (2)所有 ...

Swagger2的配置教程

Swagger2的配置教程相关推荐

最新文章

热门文章