### 回答1：
要在
Spring Boot应用程序中
配置Swagger2，您可以按照以下步骤进行操作：
1.添加
Swagger2依赖项：在pom.xml文件中，添加以下依赖项：
```
<dependency>
<groupId>io.
springfox</groupId>
<artifactId>
springfox-
swagger2</artifactId>
<version>2.9.2</version>
</dependency>
```
2.添加
Swagger2
配置类：创建一个
Swagger2
配置类，该类应该包含@Configuration和@Enable
Swagger2注释，并提供有关API文档的信息，例如标题，描述和版本号。
```
@Configuration
@Enable
Swagger2
public class
SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.
SWAGGER_2)
.select()
.apis(
RequestHandlerSelectors.any())
.paths(Path
Selectors.any())
.build()
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("My API")
.description("API for My Application")
.version("1.0")
.build();
}
}
```
3.启用
Swagger2 UI：在您的应用程序类中，添加@Enable
Swagger2注释，以便启用
Swagger2 UI。
```
@
SpringBootApplication
@Enable
Swagger2
public class MyApp {
public static void main(String[] args) {
SpringApplication.run(MyApp.class, args);
}
}
```
4.测试API文档：运行应用程序并访问http://localhost:8080/
swagger-ui.html，您将看到
Swagger2 UI，其中包含您的API文档的详细信息。
希望这可以帮助您
配置Spring Boot中的
Swagger2。
### 回答2：
Swagger2是现今广泛使用的RESTful API文档自动生成工具，它可以帮助我们生成美观易懂的API文档，并提供了一系列交互式的API测试工具。
Spring Boot是一款开箱即用的轻量级框架，能够帮助您快速搭建
Java Web应用程序。本篇文章将介绍如何在
Spring Boot项目中集成
Swagger2来生成API文档，以及如何快速测试我们的API。
第一步: 添加相应依赖
首先，在您的
Spring Boot项目的pom文件中添加以下依赖：
```xml
<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>
```
第二步:
配置Swagger2
接下来，在您的
Spring Boot项目的
配置类中添加以下代码：
```
java
@Configuration
@Enable
Swagger2
public class
SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.
SWAGGER_2)
.select()
.apis(
RequestHandlerSelectors.basePackage("<your package name>"))
.paths(Path
Selectors.any())
.build()
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("<Your API Title>")
.version("<Your API version>")
.description("<Your API description>")
.termsOfServiceUrl("<Your terms of service URL>")
.contact("<Your contact details>")
.license("<Your license>")
.licenseUrl("<Your license URL>")
.build();
}
}
```
请注意，您需要在“<your package name>”处提供包名，该包名包含您要暴露为RESTful API的类。 此外，您还需要设置API的基本信息，例如名称，版本，描述等。
第三步: 可选
配置
现在您已经成功添加了
Swagger2依赖项并
配置了
Swagger2的基本信息，现在您可以添加一些可选
配置来改进生成的API文档。例如，您可以通过以下方法来解决API文档中显示“/error”的问题：
```
java
@Configuration
@Enable
Swagger2
public class
SwaggerConfig {
// ...
@Bean
public UiConfiguration uiConfiguration() {
return UiConfigurationBuilder.builder().display
RequestDuration(true).build();
}
@Bean
public ErrorModelBuilder errorModelBuilder() {
return new DefaultErrorModelBuilder();
}
}
```
这将生成更好的API文档。
第四步：快速测试API
已经成功地将
Swagger2集成到
Spring Boot项目中！现在可以使用
Swagger界面，以交互方式测试您的API。
在“http://localhost:8080/
swagger-ui.html”上启动项目，以查看自动生成的API文档页面。
自动生成的UI界面上有完整的API信息，UI有7大模块：
-
Swagger UI界面展示了 API 文档中的所有接口。
- Model展示了定义的模型。
- Model Schema是对每个模型对象的结构定义，其包含模型对象的属性、类型以及描述信息。
- Parameters显示模型中的所有模板参数。
- Response Messages显示所有返回的消息。
- Authorizations中定义了API的访问需要的身份验证信息。
- 外部文档文档页面可以添加外部文档或链接以供使用者查看。
您可以点击任何API并使用交互式工具进行测试。 例如，您可以点击“/users”接口，然后使用
swagger UI的“Try it out”按钮，输入查询参数，然后点击“Execute”进行测试。您还可以通过在请求正文中指定JSON或XML等有效负载，并将其发送到API来测试其余功能。自动测试将显示返回的响应，并显示响应的HTTP状态代码。
### 回答3：
SpringBoot是一个开源的
Java框架，可以快速搭建Web应用程序。
Swagger2是一个开源的API框架，可以帮助
Java开发人员快速构建RESTful Web服务，并生成API文档。
SpringBoot与
Swagger2相结合，可以大大简化Web应用程序的开发过程，并生成易于使用和阅读的API文档。
一、 pom.xml文件添加
Swagger2依赖
在pom.xml文件中添加
Swagger2依赖：
```xml
<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>
```
二、
配置Swagger2
在
SpringBoot的主应用程序类中添加
Swagger2的
配置信息：
```
java
@Configuration
@Enable
Swagger2
public class
SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.
SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(
RequestHandlerSelectors.basePackage("com.example.demo.controller"))
.paths(Path
Selectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("
SpringBoot集成
Swagger2")
.description("详细信息......")
.version("1.0.0")
.build();
}
}
```
其中，@Configuration注解告诉
SpringBoot这是一个
配置文件；@Enable
Swagger2注解启用
Swagger2；createRestApi()方法返回一个Docket类实例，这个类用来
配置Swagger2的基本信息；apiInfo()方法用来
配置API文档的基本信息。
三、 使用
Swagger2
启动
SpringBoot应用程序，访问http://localhost:端口号/
swagger-ui.html，就可以看到自动生成的API文档了。
总结：
SpringBoot与
Swagger2相结合，可以大大简化Web应用程序的开发过程，并生成易于使用和阅读的API文档。其中，
Swagger2的
配置非常简单，只需要在pom.xml文件中添加
Swagger2依赖，并在
SpringBoot应用程序的主应用程序类中添加
Swagger2的
配置信息即可。
最低0.47元/天 解锁文章
1308
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
