SpringBoot集成Swagger(二)Docket的配置 | Java随笔记

·  阅读 3989
SpringBoot集成Swagger(二)Docket的配置 | Java随笔记

「这是我参与11月更文挑战的第8天,活动详情查看:2021最后一次更文挑战


相关文章

Java随笔记:Java随笔记


一、Docket

  • 上一篇文章我们只建了一个空的SwaggerConfig类,并没有对其进行任何的配置。

  • Swagger的实例是Docket,所以我们需要通过Docket来配置Swagger。

  • 我们可以看看Docket是啥。

    • image-20211110205338138.png
    • 实现了DocumentationPlugin接口。很明显,这是文档插件。那就很明了了。Swagger通过文档插件来实现输出的。
  • 再看看Docket的构造函数,方便我们返回。

    • image-20211110205925651.png
    • 构造函数需要传入DocumentationType
    • image-20211110210332611.png
    • image-20211110210926364.png
  • 很明显可以看出这是名称和版本。

  • 我们一般设置为DocumentationType.SWAGGER_2

  • 再回过头来看下Docket中的方法。

    • image-20211110211350693.png
    • 很明显的发现,所有的方法都是返回Docket本身,那么他肯定是支持链式调用的。
    • image-20211110211501205.png

二、apiInfo()

  • image-20211110211611262.png

  • 构造函数

    • image-20211110211839174.png
  • ok!那它需要啥咱给他设置啥就行了。

  • @Configuration //配置类
    @EnableSwagger2// 开启Swagger2的自动配置
    public class SwaggerConfig {
    ​
        @Bean
        public Docket docket(){
            return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
        }
    ​
        //配置文档信息
        private ApiInfo apiInfo() {
            Contact contact = new Contact("大鱼", "https://juejin.cn/user/2084329779387864/posts", "773530472@qq.com");
            return new ApiInfo(
                    "大鱼随笔记", // 标题
                    "Swagger的学习", // 描述
                    "v1.0", // 版本
                    "https://juejin.cn/user/2084329779387864/posts", // 组织链接
                    contact, // 联系人信息
                    "Apach 2.0 许可", // 许可
                    "https://juejin.cn/user/2084329779387864/posts", // 许可连接
                    new ArrayList<>()// 扩展
            );
        }
    }
    复制代码
  • 先看看原有的样子

    • image-20211110212157442.png
  • 配置后的样子

    • image-20211110212232372.png
  • 由此可以得知:apiInfo()是设置Swagger的文档信息的!

  • 水水更健康!下一篇会讲解下如何配置接口的扫描,以及基本的原理解释。


路漫漫其修远兮,吾必将上下求索~

如果你认为i博主写的不错!写作不易,请点赞、关注、评论给博主一个鼓励吧~hahah

分类:
后端
收藏成功!
已添加到「」, 点击更改