使用swagger2构建restful接口测试

swagger2是一个构建强大的在线的restful API文档，并提供给不同的团队，更加快速进行开发，也更加便捷部署。

swagger2的配置步骤：

一、首先在pom文件内配置依赖，由于项目是spring boot聚合工程所以是写在common项目内的pom内

<!-- swagger2 配置依赖 -->

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger2</artifactId>

<version>2.4.0</version>

</dependency>

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger-ui</artifactId>

<version>2.4.0</version>

</dependency>

二、对swagger2进行配置

在Application的同级目录创建一个swagger2类

package com.imooc;

import java.util.ArrayList;

import java.util.List;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;

import springfox.documentation.builders.ParameterBuilder;

import springfox.documentation.builders.PathSelectors;

import springfox.documentation.builders.RequestHandlerSelectors;

import springfox.documentation.schema.ModelRef;

import springfox.documentation.service.ApiInfo;

import springfox.documentation.service.Contact;

import springfox.documentation.service.Parameter;

import springfox.documentation.spi.DocumentationType;

import springfox.documentation.spring.web.plugins.Docket;

import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration

@EnableSwagger2

public class Swagger2 {

/**

* @Description:swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等

*/

@Bean

public Docket createRestApi() {

return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()

.apis(RequestHandlerSelectors.basePackage("com.imooc.controller"))

.paths(PathSelectors.any()).build();

}

/**

* @Description: 构建 api文档的信息

*/

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

// 设置页面标题

.title("使用swagger2构建短视频后端api接口文档")

// 设置联系人

.contact(new Contact("hph", "wx：13052019756", "huangpenghui68@163.com"))

// 描述

.description("欢迎访问短视频接口文档，这里是描述信息")

// 定义版本号

.version("1.0").build();

}

}

三、对接口进行编写打开controller

三、进入Users对象内

四、点击项目，run as -- Maven install 成功后在console里边会出现 BUILD SUCCESS 这时候在点击Application启动类 run as --spring boot App 启动完后在网站访问http://localhost:8090/swagger-ui.html  我自己的端口号是：8090