无涯教程-Spring Boot - 开启Swagger2 Swagger2 是一个开源项目，用于为RESTful

Swagger2 是一个开源项目，用于为RESTful Web服务生成REST API文档，它提供了一个用户界面，可通过Web浏览器访问RESTful Web服务。

要在Spring Boot应用程序中启用 Swagger2，您需要在无涯教程的构建配置文件中添加以下依赖项。

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

对于Gradle用户，在build.gradle文件中添加以下依赖项。

compile group: io.springfox, name: springfox-swagger2, version: 2.7.0
compile group: io.springfox, name: springfox-swagger-ui, version: 2.7.0

现在，在主Spring Boot应用程序中添加@EnableSwagger2批注。 @EnableSwagger2注释用于为您的Spring Boot应用程序启用Swagger2。

主Spring Boot应用程序的代码如下所示-

package com.learnfk.swaggerdemo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@SpringBootApplication
@EnableSwagger2
public class SwaggerDemoApplication {
public static void main(String[] args) {
SpringApplication.run(SwaggerDemoApplication.class, args);
}
}

接下来，创建Docket Bean为您的Spring Boot应用程序配置Swagger2。无涯教程需要定义基本程序包以为Swagger2配置REST API。

@Bean
   public Docket productApi() {
      return new Docket(DocumentationType.SWAGGER_2).select()
         .apis(RequestHandlerSelectors.basePackage("com.learnfk.swaggerdemo")).build();
   }

现在，将此bean添加到主Spring Boot应用程序类文件本身中，主Spring Boot应用程序类如下所示-

package com.learnfk.swaggerdemo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@SpringBootApplication
@EnableSwagger2
public class SwaggerDemoApplication {
public static void main(String[] args) {
SpringApplication.run(SwaggerDemoApplication.class, args);
}
@Bean
public Docket productApi() {
return new Docket(DocumentationType.SWAGGER_2).select()
.apis(RequestHandlerSelectors.basePackage("com.learnfk.swaggerdemo")).build();
}
}

现在，在构建配置文件中添加以下Spring Boot Starter Web依赖项以编写REST端点，如下所示-

Maven用户可以在pom.xml文件中添加以下依赖项-

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
</dependency>

Gradle用户可以在build.gradle文件中添加以下依赖项-

compile(org.springframework.boot:spring-boot-starter-web)

现在，在此处显示在Rest Controller文件中构建两个简单的RESTful Web服务GET和POST的代码-

package com.learnfk.swaggerdemo;
import java.util.ArrayList;
import java.util.List;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class SwaggerAPIController {
@RequestMapping(value="/products", method=RequestMethod.GET)
public List<String> getProducts() {
List<String> productsList=new ArrayList<>();
productsList.add("Honey");
productsList.add("Almond");
return productsList;
}
@RequestMapping(value="/products", method=RequestMethod.POST)
public String createProduct() {
return "Product is saved successfully";
}
}

完整的构建配置文件如下-

Maven-pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" 
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
   http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
<groupId>com.learnfk</groupId>
<artifactId>swagger-demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>swagger-demo</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.9.RELEASE</version>
<relativePath /> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
  </span><span class="tag">&lt;dependency&gt;</span><span class="pln">
     </span><span class="tag">&lt;groupId&gt;</span><span class="pln">org.springframework.boot</span><span class="tag">&lt;/groupId&gt;</span><span class="pln">
     </span><span class="tag">&lt;artifactId&gt;</span><span class="pln">spring-boot-starter-test</span><span class="tag">&lt;/artifactId&gt;</span><span class="pln">
     </span><span class="tag">&lt;scope&gt;</span><span class="pln">test</span><span class="tag">&lt;/scope&gt;</span><span class="pln">
  </span><span class="tag">&lt;/dependency&gt;</span><span class="pln">
  
  </span><span class="tag">&lt;dependency&gt;</span><span class="pln">
     </span><span class="tag">&lt;groupId&gt;</span><span class="pln">io.springfox</span><span class="tag">&lt;/groupId&gt;</span><span class="pln">
     </span><span class="tag">&lt;artifactId&gt;</span><span class="pln">springfox-swagger2</span><span class="tag">&lt;/artifactId&gt;</span><span class="pln">
     </span><span class="tag">&lt;version&gt;</span><span class="pln">2.7.0</span><span class="tag">&lt;/version&gt;</span><span class="pln">
  </span><span class="tag">&lt;/dependency&gt;</span><span class="pln">

  </span><span class="tag">&lt;dependency&gt;</span><span class="pln">
     </span><span class="tag">&lt;groupId&gt;</span><span class="pln">io.springfox</span><span class="tag">&lt;/groupId&gt;</span><span class="pln">
     </span><span class="tag">&lt;artifactId&gt;</span><span class="pln">springfox-swagger-ui</span><span class="tag">&lt;/artifactId&gt;</span><span class="pln">
     </span><span class="tag">&lt;version&gt;</span><span class="pln">2.7.0</span><span class="tag">&lt;/version&gt;</span><span class="pln">
  </span><span class="tag">&lt;/dependency&gt;</span><span class="pln">

</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>

Gradle – build.gradle

buildscript {
   ext {
      springBootVersion=1.5.9.RELEASE
   }
   repositories {
      mavenCentral()
   }
   dependencies {
      classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
   }
}
apply plugin: java
apply plugin: eclipse
apply plugin: org.springframework.boot
group=com.learnfk
version=0.0.1-SNAPSHOT
sourceCompatibility=1.8
repositories {
mavenCentral()
} dependencies {
compile(org.springframework.boot:spring-boot-starter-web)
testCompile(org.springframework.boot:spring-boot-starter-test)
compile group: io.springfox, name: springfox-swagger2, version: 2.7.0
compile group: io.springfox, name: springfox-swagger-ui, version: 2.7.0
}

您可以创建一个可执行的JAR文件，并使用以下Maven或Gradle命令运行Spring Boot应用程序。

对于Maven，您可以使用此处显示的命令-

mvn clean install

在" BUILD SUCCESS"之后，您可以在目标目录下找到JAR文件。

对于Gradle，您可以使用如下所示的命令-

gradle clean build

在" BUILD SUCCESSFUL"之后，您可以在build/libs目录下找到JAR文件。

现在，使用此处显示的命令运行JAR文件-

java –jar <JARFILE>

现在，应用程序将在Tomcat端口8080上启动，如下所示-

现在，在Web浏览器中单击URL，然后查看Swagger API功能。

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

无涯教程-Spring Boot - 开启Swagger2

参考链接