springdoc:
  # OpenAPI文檔相關(guān)參數(shù)
  api-docs:
    # OpenAPI文檔開關(guān), true: 開啟OpenAPI文檔訪問功能, false: 關(guān)閉。
    enabled: true       
    # JSON格式的OpenAPI文檔的訪問路徑
    path: /v3/api-docs
  # 掃描哪些包來生成OpenAPI文檔, 多個(gè)包名用逗號(hào)分隔
  packages-to-scan: * 
  # 路徑匹配規(guī)則, API路徑符合這些匹配規(guī)則才會(huì)包含到OpenAPI文檔中, 多個(gè)規(guī)則用逗號(hào)分隔
  paths-to-match: /* 
  # 返回媒體類型匹配規(guī)則, 返回媒體類型符合這些匹配規(guī)則才會(huì)包含到OpenAPI文檔中, 多個(gè)規(guī)則用逗號(hào)分隔
  produces-to-match: /* 
  # 請(qǐng)求頭匹配規(guī)則, 請(qǐng)求頭符合這些匹配規(guī)則才會(huì)包含到OpenAPI文檔中, 多個(gè)規(guī)則用逗號(hào)分隔
  headers-to-match: /* 
  # 請(qǐng)求媒體類型匹配規(guī)則, 請(qǐng)求媒體類型符合這些匹配規(guī)則才會(huì)包含到OpenAPI文檔中, 多個(gè)規(guī)則用逗號(hào)分隔
  consumes-to-match: /* 
  # 排除路徑匹配規(guī)則, API路徑符合這些匹配規(guī)則會(huì)排除在OpenAPI文檔之外, 多個(gè)規(guī)則用逗號(hào)分隔
  paths-to-exclude: 
  # 排除包匹配規(guī)則, 包名符合這些匹配規(guī)則會(huì)排除在OpenAPI文檔之外, 多個(gè)規(guī)則用逗號(hào)分隔
  packages-to-exclude: 
  # 默認(rèn)請(qǐng)求媒體類型
  default-consumes-media-type: application/json
  # 默認(rèn)返回的響應(yīng)媒體類型
  default-produces-media-type: '*/*' 
  # 是否禁用OpenAPI文檔緩存, 
  # 禁用后每次訪問${springdoc.api-docs.path}都會(huì)重新生成(適合開發(fā)調(diào)試階段)當(dāng)響應(yīng)會(huì)比較緩慢。
  cache.disabled: false 
  # 是否顯示Spring Actuator的接口
  show-actuator: false 
  # 是否自動(dòng)將類名生成為Tag
  auto-tag-classes: true 
  # 是否包含返回ModelAndView對(duì)象的接口
  model-and-view-allowed: false 
  # 是否從 @ControllerAdvice 注解獲取接口的響應(yīng)信息.
  override-with-generic-response: true 
  # 是否開啟接口分組功能, 開啟后, 一個(gè)App可以生成多個(gè)OpenAPI文檔, 每個(gè)文檔顯示一部分接口。
  api-docs.groups.enabled: true 
  # 分組配置
  group-configs:
      # 分組名稱
    - group: XXX
      # 同`springdoc.packages-to-scan`
      packages-to-scan: *    
      # 同`springdoc.paths-to-match`
      paths-to-match: /*     
      # 同`springdoc.paths-to-exclude`
      paths-to-exclude: ``   
      # 同`springdoc.packages-to-exclude`
      packages-to-exclude:   
      # 同`springdoc.produces-to-match`
      produces-to-match: /*  
      # 同`springdoc.consumes-to-match`
      consumes-to-match: /*  
      # 同`springdoc.headers-to-match`
      headers-to-match: /* 
  # webjar資源的訪問路徑前綴
  webjars.prefix: /webjars 
  # 是否翻譯屬性值, true: Schema中的屬性的值可以用Spring的表達(dá)式來編寫, 然后運(yùn)行時(shí)自動(dòng)轉(zhuǎn)成真實(shí)的取值
  api-docs.resolve-schema-properties: false 
  # 刪除無效的引用定義
  remove-broken-reference-definitions: true 
  # 是否格式化輸出的OpenAPI文檔, 方便人類閱讀
  writer-with-default-pretty-printer: false 
  # 是否啟用 deprecating model converter.
  model-converters.deprecating-converter.enabled: true 
  # 生成的Schema等組件的名稱是否使用全名(類似java的Class.getName和getSimpleName的區(qū)別)
  use-fqn: false # FQN是指 fully qualified names.
  # 是否顯示spring security的登錄接口
  show-login-endpoint: false
  # 是否預(yù)加載OpenAPI文檔, true: 程序啟動(dòng)的時(shí)候就生成OpenAPI文檔, false: 第一次訪問OpenAPI文檔的時(shí)候生成。
  pre-loading-enabled: false