程序包 com.github.xiaoymin.knife4j.aggre.core.pojo

类 SwaggerRoute

  • public class SwaggerRoute
extends java.lang.Object
    最终返回前端Swagger的数据结构
    作者:
    xiaoymin@foxmail.com 2020/10/31 9:34

    • 字段概要

      字段 
      修饰符和类型 字段 说明
      private java.lang.String basicAuth
      是否需要添加auth的header
      private java.lang.String content
      Disk模式返回的OpenAPI规范json数据，作为结构来说不需要序列化
      private boolean debug  
      private java.lang.String header  
      private boolean local
      是否本地请求,本地请求在前端无需添加Header,否则会走代理
      private java.lang.String location  
      private java.lang.String name  
      private java.lang.Integer order
      增加聚合显示顺序,参考issues：https://gitee.com/xiaoym/knife4j/issues/I27ST2
      private boolean routeProxy
      当前的分组请求是否需要服务端代理
      private java.lang.String servicePath  
      private java.lang.String swaggerVersion  
      private java.lang.String uri
      该属性JSON序列化时不能序列化出去,防止暴露服务的真实地址,存在安全隐患

    • 字段详细资料

      • name

        private java.lang.String name

      • uri

        private transient java.lang.String uri
        该属性JSON序列化时不能序列化出去,防止暴露服务的真实地址,存在安全隐患

      • header

        private java.lang.String header

      • basicAuth

        private java.lang.String basicAuth
        是否需要添加auth的header

      • location

        private java.lang.String location

      • content

        private transient java.lang.String content
        Disk模式返回的OpenAPI规范json数据，作为结构来说不需要序列化

      • swaggerVersion

        private java.lang.String swaggerVersion

      • servicePath

        private java.lang.String servicePath

      • debug

        private boolean debug

      • routeProxy

        private boolean routeProxy
        当前的分组请求是否需要服务端代理

      • local

        private boolean local
        是否本地请求,本地请求在前端无需添加Header,否则会走代理

      • order

        private transient java.lang.Integer order
        增加聚合显示顺序,参考issues：https://gitee.com/xiaoym/knife4j/issues/I27ST2
        从以下版本开始:
        2.0.9

    • 构造器详细资料

      • SwaggerRoute

        public SwaggerRoute​(DiskRoute diskRoute,
                    java.lang.String content)
        本地聚合模式
        参数:
        diskRoute - 配置
        content - 本地OpenAPI规范JSON具体内容

      • SwaggerRoute

        public SwaggerRoute​(CloudRoute cloudRoute)
        根据Cloud配置创建
        参数:
        cloudRoute - 云端配置

      • SwaggerRoute

        public SwaggerRoute​(EurekaRoute eurekaRoute,
                    EurekaInstance eurekaInstance)
        根据Eureka配置创建
        参数:
        eurekaRoute - eureka配置
        eurekaInstance - eureka实例

      • SwaggerRoute

        public SwaggerRoute​(NacosRoute nacosRoute,
                    NacosInstance nacosInstance)
        根据nacos配置
        参数:
        nacosRoute - nacos配置
        nacosInstance - nacos实例

    • 方法详细资料

      • isRouteProxy

        public boolean isRouteProxy()

      • setRouteProxy

        public void setRouteProxy​(boolean routeProxy)

      • getBasicAuth

        public java.lang.String getBasicAuth()

      • setBasicAuth

        public void setBasicAuth​(java.lang.String basicAuth)

      • isLocal

        public boolean isLocal()

      • setLocal

        public void setLocal​(boolean local)

      • getName

        public java.lang.String getName()

      • setName

        public void setName​(java.lang.String name)

      • getUri

        public java.lang.String getUri()

      • setUri

        public void setUri​(java.lang.String uri)

      • getHeader

        public java.lang.String getHeader()

      • setHeader

        public void setHeader​(java.lang.String header)

      • getLocation

        public java.lang.String getLocation()

      • setLocation

        public void setLocation​(java.lang.String location)

      • getContent

        public java.lang.String getContent()

      • setContent

        public void setContent​(java.lang.String content)

      • getSwaggerVersion

        public java.lang.String getSwaggerVersion()

      • setSwaggerVersion

        public void setSwaggerVersion​(java.lang.String swaggerVersion)

      • isDebug

        public boolean isDebug()

      • setDebug

        public void setDebug​(boolean debug)

      • getServicePath

        public java.lang.String getServicePath()

      • setServicePath

        public void setServicePath​(java.lang.String servicePath)

      • getOrder

        public java.lang.Integer getOrder()

      • setOrder

        public void setOrder​(java.lang.Integer order)