美文网首页
Springfox3 Swagger 文档集中管理使用说明

Springfox3 Swagger 文档集中管理使用说明

作者: lbjfish | 来源:发表于2020-09-08 12:42 被阅读0次

    说明

    此pom包刚出一个多月,迎来第一个springboot版本,pom包引用数不超过10(算不算前10吃螃蟹的人?)。当然有些许bug,也可能是我自己才疏学浅。主要新包网上文档说明极少。按照springfox2的配置,有些不兼容,有些直接用不了,并且很多配置和实现方式都跟以往不同。但是我已大体还原成以前配置方式,有些坑还未解决,后续有时间会继续解决。而大家基本不用怎么改自己的配置

    增加

    gateway网关文档集中化统一管理
    生产环境自动隐藏swagger

    替换

    Springfox2 升级到 Springfox3

    删除

    不再支持集合配置方式(目前nacos配置中,除了张凯的配置,其他人都要改)

    此方式不再支持

    配置方式

    仅支持这种方式(以前其他人配置稍有不对,以前张凯的配置是对的,请参照ds-order、search-center-server等服务配置方式)

    支持方式

    配置文档参数

    参照配置如下:

    dhgate:
      swagger:
        enabled: true
        docketConfig:
          basePackage: com.dhgate.saas 
          basePath: /test/**,/other/**
          excludePath: /test/v1.0/*
          docketInfo:
            title: test控制层
            description: test控制层描述
            version: v.0001
            contact:
              name: lbjfish
              url: https://github.com/lbjfish
              email: lbjfish@qq.com
    

    参数说明:

    enabled:默认swagger文档是关闭的,需要手动开启
    basePackage(非必填):扫描包路径,如果是myyshop的则必填
    basePath(非必填):如果不填,会展示所有api
    excludePath(非必填):如果不填,则不过滤任何api。excludePath可以随意跟??》
    basePath或者所有api组合过滤

    加入Springfox3支持配置

    myyshop:
      swagger:
        store:
          type: OAS30
    

    相关文章

      网友评论

          本文标题:Springfox3 Swagger 文档集中管理使用说明

          本文链接:https://www.haomeiwen.com/subject/unrlektx.html