前后端API交互-swagger2

1. jar 包依赖 (knife4j)

// knife4j
    compile 'com.github.xiaoymin:knife4j-spring-boot-starter:2.0.2'

2. 配置:

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;

/**
 * Swagger2配置
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        //添加head参数end
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("cn.xhd.contract.web"))
                .paths(PathSelectors.any())
                .build()
                .groupName("电子合同平台");
    }


    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("电子合同 API")
                .version("1.0")
                .termsOfServiceUrl("http://localhost:9917/")
                .build();
    }

}

  

3. 在controller 上添加 @ApiOperation

 

4. 效果图如下:

 

posted @ 2020-08-25 09:28  北方有鱼  阅读(253)  评论(0编辑  收藏  举报