springboot集成Swagger3.0

1、默认已经创建好Springboot 项目
2、引入swagger3.0依赖

<dependency><groupId>io.springfox</groupId><artifactId>springfox-boot-starter</artifactId><version>3.0.0</version>
</dependency>

3、创建swagger配置类

package com.yoohoo.framework.config;import io.swagger.annotations.ApiOperation;
import io.swagger.models.auth.In;
import org.springframework.beans.factory.annotation.Value;
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.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;import java.util.ArrayList;
import java.util.List;/*** @author Administrator*/@Configuration
public class SwaggerConfig {/*是否开启swagger*/@Value("${swagger.enabled}")private boolean enabled;/*设置请求前缀*/@Value("${swagger.pathMapping}")private String pathMapping;/*设置版本（项目）*/@Value("${grid.version}")private String version;@Beanpublic Docket createRestApi(){return new Docket(DocumentationType.OAS_30)/*是否开启*/.enable(enabled)/*文档描述*/.apiInfo(apiInfo())/*接口暴露*/.select()/*扫描所有带注解的方法*/.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))/*满足任何路径*/.paths(PathSelectors.any()).build()/* 设置安全模式，swagger可以设置访问token */.securitySchemes(securitySchemes()).securityContexts(securityContexts()).pathMapping(pathMapping);}private ApiInfo apiInfo(){return new ApiInfoBuilder().title("系统接口文档").description("系统详细接口文档").version(version).contact(new Contact("sumu","","xxx@163.com")).build();}/*** 安全模式，这里指定token通过Authorization头请求头传递*/private List<SecurityScheme> securitySchemes(){List<SecurityScheme> apiKeyList = new ArrayList<SecurityScheme>();apiKeyList.add(new ApiKey("Authorization", "Authorization", "header"));return apiKeyList;}/*** 安全上下文*/private List<SecurityContext> securityContexts(){List<SecurityContext> securityContexts = new ArrayList<>();securityContexts.add(SecurityContext.builder().securityReferences(defaultAuth()).operationSelector(o -> o.requestMappingPattern().matches("/.*")).build());return securityContexts;}/*** 默认的安全上引用*/private List<SecurityReference> defaultAuth(){AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];authorizationScopes[0] = authorizationScope;List<SecurityReference> securityReferences = new ArrayList<>();securityReferences.add(new SecurityReference("Authorization", authorizationScopes));return securityReferences;}
}

4、访问地址http://localhost:8080/swagger-ui/index.html

5、

@Api：用在请求的类上，表示对类的说明tags="说明该类的作用"value="该参数没什么意义，所以不需要配置"@ApiOperation：用在请求的方法上，说明方法的用途、作用value="方法的用途、作用"notes="备注说明"@ApiImplicitParams：用在请求的方法上，表示一组参数说明@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面name：参数名value：参数的汉字说明、解释required：参数是否必须传paramType：参数放在哪个地方· header --> 请求参数的获取：@RequestHeader· query --> 请求参数的获取：@RequestParam· path（用于restful接口）--> 请求参数的获取：@PathVariable· div（不常用）· form（不常用）    dataType：参数类型，默认String，其它值dataType="Integer"       defaultValue：参数的默认值@ApiResponses：用在请求的方法上，表示一组响应@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息code：数字，例如400message：信息，例如"请求参数没填好"response：抛出异常的类@ApiModel：用于响应类上，表示一个返回响应数据的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）@ApiModelProperty：用在属性上，描述响应类的属性

springboot集成Swagger3.0相关推荐

SpringBoot 集成Swagger3+knife4j
SpringBoot 集成Swagger3+knife4j 以下代码来自本人真实企业项目摘录 1. 导入SpringFox依赖 <dependenc ...
SpringBoot集成swagger3（powernode CD2207）（内含教学视频+源代码）
SpringBoot集成swagger3(powernode CD2207)(内含教学视频+源代码) 教学视频+源代码下载链接地址:https://download.csdn.net/download ...
springboot集成swagger3与knife4j
springboot集成swagger3 swagger3的springboot启动器jar包 <!-- https://mvnrepository.com/artifact/io.spring ...
SpringBoot集成OAuth2.0有新方案了
背景说明 SpringBoot 2.X已经抛弃了对Spring Security OAuth模块,而是通过Spring Security 5 支持了OAuth 2.0.客户端.资源服务器.授权服务器. ...
Gateway集成swagger3.0
一.依赖 <dependency><groupId>io.springfox</groupId><artifactId ...
springboot集成activity6.0.0
个人博客地址:www.wzbjsz.cn 在线浏览地址:activiti.wzbjsz.cn 什么是工作流? 工作流(Workflow),就是通过计算机对业务流程自动化执行管理.它主要解决的是&quo ...
SpringBoot集成Mybatis(0配置注解版)
Mybatis初期使用比较麻烦,需要各种配置文件.实体类.dao层映射关联.还有一大推其它配置.当然Mybatis也发现了这种弊端,初期开发了generator可以根据表结构自动生成实体类.配置文件和 ...
springBoot集成Activiti5.0
一.工作流简介 1.什么是工作流? 简单的理解就是工作的流程,这里的流程指的是,完成一个企业中具体业务的一系列工作步骤,所有的步骤合在一起就是业务从开始到结束的流转过程. 从计算机系统的角度来讲,工作 ...
SpringBoot集成knife4j实现Swagger接口文档
前言:如果你是后台开发,提供restful接口给前端,建议你使用Swagger3提供restful的接口文档自动生成和在线接口调试.knife4j是对Swagger进一步封装,其优化了API文档的UI ...
SpringBoot教程(十六) | SpringBoot集成swagger（全网最全）
一. 接口文档概述 swagger是当下比较流行的实时接口文文档生成工具.接口文档是当前前后端分离项目中必不可少的工具,在前后端开发之前,后端要先出接口文档,前端根据接口文档来进行项目的开发,双方开发 ...

springboot集成Swagger3.0

springboot集成Swagger3.0相关推荐

最新文章

热门文章