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

Maven项目如何配置Swagger

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

Maven项目如何配置Swagger

1、导入swagger相关依赖:

为了避免http://localhost:8080/swagger-ui.html出现404错误,希望此处不要导入最新版本的swagger依赖。


    io.springfox
    springfox-swagger2
    2.9.2



    io.springfox
    springfox-swagger-ui
    2.9.2


2、配置swagger的config
@Configuration
@EnableSwagger2  //开启Swagger2
public class SwaggerConfig {
    
}
3、启动项目:界面介绍:

4、Swagger配置扫描接口: Docket.select()属性介绍
public Docket defaultApi2() {
    Docket docket=new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            //RequestHandlerSelectors配置要烧苗接口的方式
            //basePackage()指定要扫描的包
            //any()扫描全部
            //none()不扫描
            //withClassAnnotation()扫描类上的注解,参数是一个注解的反射对象
            //withMethodAnnotation()扫描方法上的注解
            .apis(RequestHandlerSelectors.basePackage("com.example.swagger.controller"))
            //paths()过滤什么路径
            .paths(PathSelectors.ant("/hello/**"))
            .build();
    return docket;
}
5、配置是否启用Swagger
public Docket defaultApi2() {
    Docket docket=new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .enable(true)//表示是否使用Swagger,如果为false,则Swagger不能再浏览器中访问
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.example.swagger.controller"))
            .build();
    return docket;
}
6、Swagger如何生成静态接口文档: 方法一(使用springfox-swagger-ui依赖时):

​ 生成静态文档有两种方法
​ (1).编写java代码生成
​ (2).Maven插件完成
`注:具体操作见:https://blog.csdn.net/weixin_42648692/article/details/105641976

方法二(使用Knife4j依赖时):

(1)添加依赖坐标:


	com.github.xiaoymin
	knife4j-spring-boot-starter
	2.0.7


(2)修改配置文件:

@Configuration
@EnableSwagger2
class Swagger2Config {

    @Bean(value = "defaultApi2")
    //配置Swagger的Dock的bean实例
    public Docket defaultApi2() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
        return docket;
    }
//配置Swagger信息=apiInfo
    private ApiInfo apiInfo(){
        //作者信息
        Contact contact = new Contact("cxh", "http://localhost:8081", "邮箱");
        return new ApiInfo(
                "SwaggerApi文档",
                "swagger测试",
                "v1.0",//版本号
                "http://localhost:8081",
                contact,//作者信息
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());

    }

}

​ (3)重启服务查看接口

​ 访问地址:http://localhost:8081/doc.html,即可查看接口文档,并且提供word、Html和pdf等下载格式,实际运行截图见下图:


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

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

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