集成Swagger2构建API文档

2019独角兽企业重金招聘Python工程师标准>>>

修改pom文件，添加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>

 

 

新建一个swagger的配置类SwaggerConfig.java

package cn.enjoy.utils;

 

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;

 

@Configuration

@EnableSwagger2

public class SwaggerConfig {

 

    @Bean

    public Docket createRestApi() {

        return new Docket(DocumentationType.SWAGGER_2)

                .apiInfo(apiInfo())

                .select()

                .apis(RequestHandlerSelectors.basePackage("cn.enjoy"))// 指定扫描包下面的注解

                .paths(PathSelectors.any())

                .build();

    }

    // 创建api的基本信息

    private ApiInfo apiInfo() {

        return new ApiInfoBuilder()

                .title("集成Swagger2构建RESTful APIs")

                .description("集成Swagger2构建RESTful APIs")

                .termsOfServiceUrl("http://www.xiangxueketang.cn/")

                .contact(new Contact("enjoy","cn.xiangxueketang","enjoy@enjoy.cn"))

                .version("1.0.0")

                .build();

    }

}

 

新建Controller用于显示相关接口

package cn.enjoy.controller;

 

 

import io.swagger.annotations.ApiImplicitParam;

import io.swagger.annotations.ApiOperation;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestMethod;

import org.springframework.web.bind.annotation.RestController;

 

import java.util.HashMap;

import java.util.Map;

 

@RestController

@RequestMapping(value="/swagger")

public class SwaggerController {

    @ApiOperation(value="获取用户信息", notes="根据id来获取用户详细信息")

    @ApiImplicitParam(name="id", value="用户ID", required=true, dataType="String")

    @RequestMapping(value="/{id}", method= RequestMethod.GET)

    public Map<String,String> getInfo(@PathVariable String id) {

        Map<String ,String> map = new HashMap<String, String>();

        map.put("name", "lison");

        map.put("age", "38");

        return map;

    }

}

 

访问：http://localhost:8080/swagger-ui.html

转载于:https://my.oschina.net/u/2351011/blog/3054224