Springdoc dengan beberapa api-docs

Aug 31 2020

Saya ingin mengelompokkan tiga dokumen API dalam satu swagger-ui. Saya menggunakan Springdoc. Masing-masing dari tiga dokumen API memiliki url sendiri. (Mereka tidak berada dalam proyek yang sama). Apakah ada cara untuk melakukan ini?

Sunting: Sekarang bekerja seperti ini:

springdoc:
  swagger-ui:
    path: /
    urls:
      - name: App1
        url: http://app1.domain.com/v3/api-docs
      - name: App2
        url: http://app2.domain.com/v3/api-docs
      - name: App3
        url: http://app3.domain.com/v3/api-docs

Jawaban

2 brianbro Aug 31 2020 at 21:30

Jawabannya sudah tersedia di FAQ:

  • https://springdoc.org/faq.html#how-can-i-agreagte-external-endpoints-exposing-openapi-3-spec-inside-one-single-application

Properti springdoc.swagger-ui.urls. *, Cocok untuk dikonfigurasi eksternal (/ v3 / api-docs url):

  • Misalnya jika Anda ingin menyepakati semua titik akhir layanan lain, di dalam satu aplikasi tunggal. Jangan lupa bahwa CORS juga perlu diaktifkan.

Rincian properti tersedia di sini:

  • https://springdoc.org/springdoc-properties.html