SpringBoot成长笔记（六）使用swagger实现restfulapi

环境

后台生成了很多restful api的时候，不论管理、查询、测试都不能一目了然，swagger帮助我们解决了这个问题
开发环境：参考SpringBoot成长笔记（一）环境搭建

pom.xml增加依赖配置

<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>

代码

配置代码

package com.mhm.configuration;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * API 配置
 * Created by MHm on 2018/10/22.
 */
@Configuration
@EnableSwagger2
public class SwaggerCinfiguration {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
        .apis(RequestHandlerSelectors.basePackage("com.mhm")).paths(PathSelectors.any()).build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("告警模拟工具").description("autho:mhm")
        .termsOfServiceUrl("http://localhost:8086/").contact(new Contact("mhm", null, "mhm"))
        .version("V.10").build();
    }
}

运行

就这么简单

Github

Github