Springboot 整合springfox

1 导包

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

版本要选择最新的3.x.x版本

2 配置

创建一个java配置类SpringfoxConfiguration配置Docket（文档信息）

@Configuration
public class SpringfoxConfiguration {@Beanpublic Docket docket(){return new Docket(DocumentationType.OAS_30)// 文档名.groupName("springfox-hello")// 添加info信息.apiInfo(info())// 开启选择器.select()// 选择要扫描的包，包下的所有控制器都会陪扫描.apis(RequestHandlerSelectors.basePackage("com.aion.springfoxdemo.controller"))// 选择要匹配的路径.paths(PathSelectors.ant("/student"))// 匹配所有的路径
//                .paths(PathSelectors.any()).build();}// 创建info信息private ApiInfo info(){return new ApiInfoBuilder().title("springfox test api").description("这只是用来测试的简单api")// 添加可联系人信息.contact(new Contact( "aion", "http://aion.com", "aion@qq.com")).version("0.1").build();}
}

3 创建控制器

package com.aion.springfoxdemo.controller;import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
@Tag(name = "student", description = "学生管理")
public class StudentController {@Tag(name = "student")@Operation(summary = "一个只会返回student的api")@ApiResponse(responseCode = "200", description = "成功使用了此接口")@GetMapping("/student")public String get(){return "student";}
}

4 查看api文档

启动项目
在浏览器中输入http://localhost:8080/swagger-ui/index.htm就能查看api文档

Springboot 整合springfox相关推荐

SpringBoot整合springFox
SpringBoot整合springFox 1 springFox 介绍 springFox算是swagger优化.它可以跟据业务代码自动生成相关的api接口文档,尤其用于restful风格中的项目, ...
六、springboot整合swagger
六.springboot整合swagger 简介 swagger 提供最强大,最易用的工具,以充分利用OpenAPI规范. 官网 : https://swagger.io/ 准备工作 pom.xml ...
Springboot整合swagger指南
Springboot整合swagger指南 1. 安装使用 1.1 下载依赖 <dependency><groupId>io.springfox</groupId> ...
SpringBoot学习笔记(16)----SpringBoot整合Swagger2
Swagger 是一个规范和完整的框架,用于生成,描述,调用和可视化RESTful风格的web服务 http://swagger.io Springfox的前身是swagger-springmvc,是 ...
SpringBoot 整合 knife4j
文章目录简述 2. 导入依赖 3. 创建配置类 4. 创建User实体类 5. 创建开发接口 6. 启动项目简述 Swagger是一款测试文档Api接口,具体用法见SpringBoot整合Swag ...
SpringBoot 整合swagger3.X
SpringBoot 整合swagger3.X 1. 引入依赖 2. swagger配置 3. 启动程序访问 4. 集成增强文档knife4j 4.1 添加依赖 4.2 swagger配置类添加@En ...
业务规范之springboot整合swagger2
业务规范(整合swagger2) ###业务规范之springboot整合swagger2 ###业务规范之统一验证 ###业务规范之统一返回体 ###业务规范之统一异常处理和统一响应二.整合swa ...
SpringBoot整合knife 4j
文章目录 knife 4j (1) 简介 (2) 核心功能 (3) 快速集成 knife 4j (1) 简介 knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身 ...
SpringBoot整合阿里云短信服务详细过程（保证初学者也能实现）
前言网上关于实操性的文章普遍大部分都记录不全,要么只记录重点部分,对于刚学习的小伙伴来说看起来是比较困难的所以,基于这一点. 该文章会详细介绍使用SpringBoot整合阿里云短信服务的每一步过程 ...

Springboot 整合springfox

1 导包

2 配置

3 创建控制器

4 查看api文档

Springboot 整合springfox相关推荐

最新文章

热门文章