通过Swagger暴露接口文档

 

 

 

通过Swagger暴露接口文档

 

 

什么是Swagger

　　Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。

 

作用：

　　1. 接口的文档在线自动生成。

　　2. 功能测试。

 

 

 

 

 

 

 

 

引入springfox-swagger相关依赖

         
       <dependency>
        <groupId>io.springfox</groupId>
         <artifactId>springfox-swagger2</artifactId>
         <version>${springfox.version}</version>
       </dependency>
       
        <dependency>
        <groupId>io.springfox</groupId>
         <artifactId>springfox-swagger-ui</artifactId>
         <version>${springfox.version}</version>
       </dependency>
          

 说明：

        1）springfox.version>2.2.2</springfox.version>

 

 

更改启动类

package com.mooc.house.user;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@EnableDiscoveryClient
@EnableSwagger2
public class UserServiceApplication {

	public static void main(String[] args) {
		SpringApplication.run(UserServiceApplication.class, args);
	}
}

说明：

   1） 通过@EnableSwagger2注解来启动Swagger2

 

 

 

启动服务测试

 

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