SpringBoot next day (generating online documentation)

 

A .SpringBoot use Swagger2 build API documentation:

　　The first step: Add Swagger2 dependency in pom.xml:

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

　　Step 2: Create Swagger2 configuration class:

package com.offcn.springbootdemo.config;


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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


@Configuration
EnableSwagger2 @ // open the online documentation generated 
public  class SwaggerConfig {
     // 1 statement attribute api documentation builder 
    Private ApiInfo apiInfo () {
         return  new new ApiInfoBuilder (). Title ( "springboot use online documentation to build RestFul style Apis" )
                .description("在线文档").termsOfServiceUrl("http://aaa.com/").contact("java")
                .version("1.0").build();
    }
    // 2 Configuration core configuration information 
    public Docket No. creatRestApi () {
         return  new new Docket No. (DocumentationType.SWAGGER_2)
                .apiInfo (apiInfo ())
                .select().apis(RequestHandlerSelectors.basePackage("com.aaa.springbootdemo.controller"))
                .paths(PathSelectors.any()).build();
    }
}

　　Step 3: Add documentation comments in the code controller layer:

　　　　To add a description to the API by @ApiOperation comment

　　　　To add a description to the parameters @ApiImplicitParams and @ApiImplicitParam comment

View Swagger2 document access address : http: // localhost: 8080 / swagger-ui.html