複数のOpenAPI 3仕様ファイルを組み合わせてどのように組み合わせていますか？

Question

OpenAPI 3仕様を使用して書かれたAPI仕様を組み合わせて、現在$refを使用して互いに参照する複数のファイルに分割されています。どうやってやるの？

Answer 1

私は最近これをするための迅速なツールを書きました。私はそれをOpenapi-Mergeと呼びます。ライブラリと関連するCLIツールがあります。

• https://www.npmjs.com/package/openapi-merge
• https://www.npmjs.com/package/openapi-merge-cli

CLIツールを使用するには、設定ファイルを作成してから_npx openapi-merge-cli_を実行するだけです。構成ファイルはかなり単純で、次のようになります。

_{
  "inputs": [
    {
      "inputFile": "./gateway.swagger.json"
    },
    {
      "inputFile": "./jira.swagger.json",
      "pathModification": {
        "stripStart": "/rest",
        "prepend": "/jira"
      }
    },
    {
      "inputFile": "./confluence.swagger.json",
      "disputePrefix": "Confluence",
      "pathModification": {
        "prepend": "/confluence"
      }
    }
  ], 
  "output": "./output.swagger.json"
}
_

詳細については、 NPMパッケージのReadme を参照してください。