zoukankan      html  css  js  c++  java
  • 接口开发文档swagger

    依赖

    <!-- swagger2 依赖 -->
    		<dependency>
    			<groupId>io.springfox</groupId>
    			<artifactId>springfox-swagger2</artifactId>
    			<version>2.7.0</version>
    		</dependency>
    		<!-- Swagger第三方ui依赖 -->
    		<dependency>
    			<groupId>com.github.xiaoymin</groupId>
    			<artifactId>swagger-bootstrap-ui</artifactId>
    			<version>1.9.6</version>
    		</dependency>
    

     工具类

    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.*;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spi.service.contexts.SecurityContext;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    import java.util.ArrayList;
    import java.util.List;
    
    /**
     * Swagger2配置
     *
     * @author zhoubin
     * @since 1.0.0
     */
    @Configuration
    @EnableSwagger2
    public class Swagger2Config {
        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.his.base.org.controller"))
                    .paths(PathSelectors.any())
                    .build()
                    //添加登录认证
                    .securityContexts(securityContexts())
                    .securitySchemes(securitySchemes());
        }
    
        private List<SecurityContext> securityContexts() {
            //设置需要登录认证的路径
            List<SecurityContext> result=new ArrayList<>();
            result.add(getContextByPath("/hello/.*"));
            return result;
        }
        private SecurityContext getContextByPath(String pathRegex) {
          return SecurityContext.builder()
                  .securityReferences(defaultAuth())
                  .forPaths(PathSelectors.regex(pathRegex)).build();
        }
    
        private List<SecurityReference> defaultAuth() {
           List<SecurityReference> result = new ArrayList<>();
           AuthorizationScope authorizationScope = new AuthorizationScope("global",
                    "accessEverything");
           AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
           authorizationScopes[0] = authorizationScope;
           result.add(new SecurityReference("Authorization",authorizationScopes));
           return result;
        }
    
    
    
        private ApiInfo apiInfo() {
            //设置文档信息
            return new ApiInfoBuilder()
                    .title("云E办接口文档")
                    .description("云E办接口文档")
                    .contact(new Contact("xxxx", "http:192.168.1.187:9705/doc.html",
                            "xxxx@xxxx.com"))
                    .version("1.0")
                    .build();
        }
        private List<ApiKey> securitySchemes(){
            //设置请求头信息
            List<ApiKey> result = new ArrayList<>();
            ApiKey apiKey = new ApiKey("Authorization","Authorization","header");
            result.add(apiKey);
            return result;
        }
    
    }
  • 相关阅读:
    linux 系统管理(2) 文件或目录数量统计
    linux系统管理(1)之 内核编译选项查看
    apt 命令大全
    system命令
    ubuntu 登陆闪回
    网络知识之ipset
    mac 系统配置(一)
    windows下的qt编译器配置
    QT5.14.1+qwt-6.1.4编译
    无法打开源文件QtWidgets/QApplication
  • 原文地址:https://www.cnblogs.com/yangxiaoli/p/15394142.html
Copyright © 2011-2022 走看看