Swagger 生成 - 相同架構下的參考架構

Question

所以我正在為我們的 api 生成一個 yaml 文件。 問題是，在我的代碼中，我有一個 Account 對象，它具有屬性和作為子帳戶的自身列表。

Yaml 看起來像這樣：

Account:
  type: Object
  properties: 
    name:
      type: string
    <other attributes>
      <other types>
    subAccounts:
      type: array
      $ref: '#/components/schema/Account'

架構會生成，但 subAccount 不會。 如果我添加“描述” - 它將生成但具有空白屬性。 有什么方法可以正確引用同一個對象嗎？

Answer 1

我做了一個解決方法 - 我創建了一個名為 SubAccount 的新類，在其上擴展了 Account，然后將 List 類型從 Account 更改為 SubAccount。

效果很好。

但是，如果有人有適當的解決方案 - 請在此處發布。 tnx。

Answer 2

我以前遇到過這個問題，我也沒有找到任何可以“為我解決這個問題”的解決方案。 實際上結果是我的 API 中有這樣的循環依賴是我的問題。 如果您必須使用相同的對象，那么我建議您使用自己的規則覆蓋 Swagger 配置，您基本上可以指定一切。

盡管如此，還要考慮到這種“無盡”數據結構的可能性可能很容易導致內存問題。 Rye 的“解決方法”解決方案實際上可能是准確指定此依賴關系樹可能有多深的最佳解決方案。