Swagger配置

小阡打工日记

已于 2024-04-09 19:30:33 修改

阅读量1.1k

点赞数 30

文章标签： java 开发语言

于 2024-04-09 19:21:30 首次发布

本文链接：https://blog.csdn.net/m0_64021225/article/details/137564155

版权

要配置Swagger，你可以按照以下步骤进行操作：

添加Swagger依赖：在你的项目中，需要添加Swagger的依赖。具体的依赖配置会根据你使用的构建工具（如Maven、Gradle等）而有所不同。
创建Swagger配置类：创建一个Swagger配置类，该类应该使用@Configuration注解进行标注。在配置类中，你可以设置Swagger的一些属性，例如API文档的标题、描述、版本等。
配置Swagger Docket：在Swagger配置类中，创建一个Docket对象来配置Swagger的行为。Docket是Swagger的主要配置对象，它定义了API文档的一些属性，例如扫描的包、API的选择规则等。
启用Swagger：在你的应用程序的主类中，使用@EnableSwagger2注解启用Swagger。这将使得Swagger可以自动创建API文档，并提供一个交互式的界面来查看和测试API。
配置API信息：在每个Controller的方法上添加Swagger的注解，例如@ApiOperation、@ApiParam等，用于提供更详细的API信息，例如接口的描述、请求参数、响应类型等。

完成以上步骤后，你的应用程序将生成一个API文档，可以通过Swagger的界面来访问和测试API。你可以使用Swagger的注解来进一步定制和配置API文档的外观和功能。

在IntelliJ IDEA中使用Swagger可以按照以下步骤进行配置：

添加Swagger依赖：打开你的项目的pom.xml文件（如果是Maven项目）或build.gradle文件（如果是Gradle项目），在文件中添加Swagger依赖。你可以使用以下依赖配置：

Maven：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

Gradle：

implementation 'io.springfox:springfox-swagger2:2.9.2'
implementation 'io.springfox:springfox-swagger-ui:2.9.2'

创建Swagger配置类：在你的项目中创建一个Java类，用于配置Swagger。你可以命名该类为SwaggerConfig或其他类似的名称。在该类上添加@Configuration注解以表示它是一个配置类。
配置Swagger Docket：在Swagger配置类中，创建一个Docket对象来配置Swagger的行为。你可以使用select()方法指定需要生成API文档的包路径。例如，使用apis(RequestHandlerSelectors.basePackage("your.package.name"))来指定包路径。使用build()方法来构建Docket对象。
启用Swagger：在你的应用程序的主类上添加@EnableSwagger2注解，以启用Swagger。
运行应用程序：运行你的应用程序，确保它能够正常启动。
查看API文档：在浏览器中打开以下URL：http://localhost:8080/swagger-ui.html（假设你的应用程序在本地使用默认的8080端口运行）。这将打开Swagger的交互式界面，你可以在该界面上查看和测试API。