1.引入依赖,版本3.0.0只引入一个即可
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
2. 配置类SwaggerConfig
package org.fh.config;
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.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
/**
* 说明:Swagger 接口API生成
* 作者:FH Admin
* from fhadmin.org
*/
@Configuration
@EnableOpenApi
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("org.fh.controller")) // 为当前包路径
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("FH Admin Swagger3 RESTful API") // 页面标题
.version("3.0") // 版本号
.description("fhadmin.org") // 描述
.build();
}
}
3.Swagger 拦截配置
package org.fh.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
/**
* 说明:Swagger 拦截配置
* 作者:FH Admin
* from fhadmin.org
*/
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.
addResourceHandler("/swagger-ui/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/")
.resourceChain(false);
}
@Override
public void addViewControllers(ViewControllerRegistry registry) {
registry.addViewController("/swagger-ui/")
.setViewName("forward:/swagger-ui/index.html");
}
}
4.访问 127.0.0.1:8081/swagger-ui/index.html
5.接口说明案例
处理类上加注解,比如
@Api("用户注册登录接口")
在方法上加注解,比如
@ApiOperation(value = "登录", notes="请求登录验证用户接口,校验登录是否成功")
@ApiImplicitParam(name = "KEYDATA", value = "用户名密码混淆码组合", paramType = "query", required = true, dataType = "String")
相关推荐
Swagger3 API接口文档规范课程 1.Swagger3 简介 2.Swagger3 HelloWorld实现 第一步:我们新建一个SpringBoot项目;...6 Swagger3 Docket 开关&过滤&分组 配置详解 6.1 开关设置enable 6.2 设置过滤 6.3 设置分组
2. **配置 Swagger**:创建 Swagger 配置类,例如 SwaggerConfig.java: ```java @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket...
Swagger 的核心目标是确保客户端和服务器的同步更新,以减少开发中的沟通成本和错误。 在实际项目开发中,Swagger 能够根据业务代码自动生成 API 文档,这样前端开发者就能清晰地了解后端提供的接口,进行在线测试...
- 及时更新Swagger2的配置和注解,确保文档与实际接口的一致性。 通过以上步骤,我们便可以在SpringBoot项目中成功集成Swagger2,实现API的自动化文档生成和测试。这不仅可以提高开发效率,也能为团队协作和API...
为了解决这个问题,本文档建议将`swagger-annotations`和`swagger-models`的版本更新至1.5.22,以避免运行时出现的异常,比如`NumberFormatException`。 #### 六、解决`NumberFormatException`异常 在`1.5.20`版本...
### TP5集成Swagger知识点详解 #### 一、Swagger概述与工作原理 Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。它旨在解决的一个核心问题是API文档的生成和维护问题。对于...
这个项目的文件列表中可能包含了Spring Boot应用的核心配置文件(如application.yml或application.properties)、源代码(如Java Controller、Service、Repository)、Swagger配置类、以及MyBatis的相关Mapper接口...
四、Swagger2 的配置详解 Swagger2Config 配置类中有多个方法,可以用来配置 Swagger2 的基本信息。例如 apiInfo() 方法可以用来配置 API 文档的标题、描述、版本等信息。select() 方法可以用来选择哪些 API 需要...
SpringBoot整合Swagger2实例详解 在现代Web开发中,API文档的重要性不言而喻,它为开发者提供了清晰的接口说明,使得开发、测试和维护工作更加高效。Swagger2是一款流行的API文档工具,它能自动生成RESTful API的...
本教程将围绕如何使用C#和.NET来通过Swagger将接口导出为Word文档进行详解。 首先,你需要在你的项目中引入Swagger。可以通过NuGet包管理器安装`Swashbuckle.AspNetCore`,这将为你的ASP.NET Web API项目添加...
**SpringBoot1与Swagger2整合应用详解** 在现代的Web开发中,API接口已经成为系统间交互的重要桥梁。SpringBoot作为Java领域广泛使用的轻量级框架,简化了项目的搭建和配置。Swagger2则是一款强大的API文档生成工具...
Spring Boot 整合 Swagger 2.9.2 含 YAML 配置文件的代码详解 本文主要介绍了如何将 Spring Boot 2.1.16 整合 Swagger 2.9.2,並使用 YAML 配置文件。 Swagger 是一个流行的 API 文档生成工具,可以帮助开发者快速...
3. **注解详解**: - `@Api`: 这个注解用在控制器类上,表示该类是API的一部分,可以包含多个API操作。 - `@ApiOperation`: 用于方法,描述一个HTTP操作(如GET、POST等)的作用。 - `@ApiParam`: 用于方法参数,...
1. Swagger 注解详解: - `@Api`:此注解用于标记一个类,表示该类是RESTful API的一个资源。你可以指定其描述信息,比如API的全局描述。 - `@ApiOperation`:此注解用于标记一个方法,表示这个方法对应于API的一...
在上面的代码中,我们使用@Configuration注解指定了Swagger配置类,并使用@EnableSwagger2注解启用Swagger2。然后,我们定义了createRestApi()方法来生成API文档。这个方法使用Docket对象来构建API文档,并使用...
以下是关于"SpringBoot整合Swagger"的知识点详解: 1. **Spring Boot**: Spring Boot 是基于Spring框架的快速开发工具,它通过自动化配置和起步依赖简化了创建独立的、生产级别的基于Spring的应用程序。Spring ...
《SpringBoot-Swagger2实战详解》 在现代软件开发中,API的文档化和测试是必不可少的环节,而Swagger2作为一个强大的API文档工具,能够帮助我们轻松地管理和测试RESTful API。本教程将深入探讨如何在SpringBoot项目...
### SpringBoot整合Swagger2知识点详解 #### 一、Swagger2简介与作用 Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。Swagger 可以帮助开发者更快地理解 API 的功能,...
SpringBoot整合Swagger详解 在现代Web开发中,API文档的重要性不言而喻,它能帮助开发者理解接口的使用方法和参数。Swagger是一个优秀的API文档工具,它可以生成清晰、交互式的API文档,使得开发者能够轻松地测试和...
- 定期更新Swagger配置,确保文档与实际代码同步。 - 使用版本控制,当API有重大变更时,考虑升级版本号。 总的来说,Swagger与SpringMVC的整合,为API开发提供了便利,使得API的创建、测试和文档化变得更加简单...