一、初始化SpringBoot项目

二、引入依赖pom

<!--整合Swagger3.0 -->
<dependency> <groupId>io.springfox</groupId>  <artifactId>springfox-boot-starter</artifactId>  <version>3.0.0</version>
</dependency>

三、SwaggerConfig配置类

package com.csdn.config;import io.swagger.annotations.ApiOperation;
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;@Configuration
public class SwaggerConfig {@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.OAS_30)// 是否启用Swagger.enable(true)// 用来创建该API的基本信息，展示在文档的页面中（自定义展示的信息）.apiInfo(apiInfo())// 设置哪些接口暴露给Swagger展示.select()// 扫描所有有注解的api，用这种方式更灵活.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))// 扫描指定包中的swagger注解//.apis(RequestHandlerSelectors.basePackage("com.csdn.controller"))// 扫描所有 .apis(RequestHandlerSelectors.any()).paths(PathSelectors.any()).build();}/*** 添加摘要信息*/private ApiInfo apiInfo() {// 用ApiInfoBuilder进行定制return new ApiInfoBuilder()// 设置标题.title("在线接口文档")// 描述.description("API在线接口文档管理")// 作者信息.contact(new Contact("admin", null, null))// 版本.version("1.0.0").build();}
}

四、编写测试接口

package com.csdn.controller;import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;@Api(tags = "api接口测试")
@RestController
@RequestMapping("/api")
public class ApiController {@ApiOperation(value = "查询所有用户")@GetMapping("/users")public String list() {return "1";}@ApiOperation(value = "添加用户")@PostMapping("/users")public String add() {return "2";}@ApiOperation(value = "编辑用户")@PutMapping("/users")public String update() {return "3";}@ApiOperation(value = "删除用户")@DeleteMapping("/users")public String delete() {return "4";}
}

五、开启Swagger注解

@EnableOpenApi

六、访问在线接口文档

http://localhost:8080/swagger-ui/index.html

SpringBoot实战教程（1）| 整合Swagger3.0.0相关推荐

视频教程-SpringBoot实战教程：SpringBoot入门及前后端分离项目开发-Java
SpringBoot实战教程:SpringBoot入门及前后端分离项目开发十三,CSDN达人课课程作者,CSDN 博客作者,现就职于某网络科技公司任职高级 Java 开发工程师,13blog.sit ...
springboot springmvc mybatis_深圳嘉华学校之springboot实战教程
Springboot实战教程目录第一章 springBoot概述... 2 href="https://zhuanlan.zhihu.com/write#_Toc508178432&qu ...
SpringBoot实战教程（2）| 整合knife4j3.0.3
Knife4j的前身是swagger-bootstrap-ui,前身swagger-bootstrap-ui是一个纯swagger-ui的ui皮肤项目.项目正式更名为knife4j,取名knife4j ...
SpringBoot实战教程（6）| 整合Druid
Apache Druid是一个实时分析型数据库,旨在对大型数据集进行快速的查询分析("OLAP"查询).Druid最常被当做数据库来用以支持实时摄取.高性能查询和高稳定运行的应用场 ...
SpringBoot 实战 (十二) | 整合 thymeleaf
微信公众号:一个优秀的废人如有问题或建议,请后台留言,我会尽力解决你的问题. 前言如题,今天介绍 Thymeleaf ,并整合 Thymeleaf 开发一个简陋版的学生信息管理系统. Spring ...
springboot（05）整合 Swagger3 生成 API 接口文档
Spring Boot 集成 Swagger3 Swagger是一种开源的API文档工具,它可以自动生成RESTful API文档,让开发者可以更容易地理解和使用API.使用Swagger可以提高开发 ...
SpringBoot实战教程（3.1）——失败重试机制
一.Guava-Retry Guava retryer工具与spring-retry类似,都是通过定义重试者角色来包装正常逻辑重试,但是Guava retryer有更优的策略定义,在支持重试次数和重试 ...
SpringBoot实战教程（4）| 整合Mybatis
MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code,并且改名为MyBatis .2 ...
SpringBoot实战教程（7）| 整合JPA
JPA是Java Persistence API的简称,中文名Java持久层API,是JDK 5.0注解或XML描述对象-关系表的映射关系,并将运行期的实体对象持久化到数据库中. 目录一.初始化sp ...

SpringBoot实战教程（1）| 整合Swagger3.0.0

一、初始化SpringBoot项目

二、引入依赖pom

三、SwaggerConfig配置类

四、编写测试接口

五、开启Swagger注解

六、访问在线接口文档

SpringBoot实战教程（1）| 整合Swagger3.0.0相关推荐

最新文章

热门文章