栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

java引入swagger2

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

java引入swagger2

1.pom引入swagger相关api

    
    
      io.springfox
      springfox-swagger2
      ${swagger.version}
    
    
      io.springfox
      springfox-swagger-ui
      ${swagger.version}
    
    
      com.github.xiaoymin
      knife4j-spring-boot-starter
      ${knife4j.version}
    

2.java写入配置项代码

package com.xiaogj.file.manager.config;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import java.util.ArrayList;
import java.util.List;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.documentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


@Configuration
@EnableSwagger2
@EnableKnife4j
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        ParameterBuilder parameter = new ParameterBuilder();
        parameter.name("token").description("令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        List parameters = new ArrayList<>();
        parameters.add(parameter.build());

        return new Docket(documentationType.SWAGGER_2)
                .apiInfo(restApiInfo())
                .select()
                // 指定包名
                .apis(RequestHandlerSelectors.basePackage("xxx.xxx.controller"))
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(parameters);
    }

    private ApiInfo restApiInfo() {
        //设置文档信息
        return new ApiInfoBuilder()
                .title("API文档")
                .description("实例")
                .termsOfServiceUrl("no terms of serviceUrl")
                .version("1.0")
                .build();
    }
}

3.启动后台进入网址即可 http://localhost:8080/api/swagger-ui.html#/

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/785384.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号