Springdoc mit mehreren API-Dokumenten

Aug 31 2020

Ich möchte drei API-Dokumente in einer Swagger-Benutzeroberfläche gruppieren. Ich benutze Springdoc. Jedes der drei API-Dokumente hat eine eigene URL. (Sie sind nicht im selben Projekt). Gibt es eine Möglichkeit, dies zu tun?

Bearbeiten: Es funktioniert jetzt so:

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

Antworten

2 brianbro Aug 31 2020 at 21:30

Die Antwort ist bereits in den FAQ verfügbar:

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

Die Eigenschaften springdoc.swagger-ui.urls. * Sind zum Konfigurieren von externen (/ v3 / api-docs url) geeignet:

  • Wenn Sie beispielsweise alle Endpunkte anderer Dienste in einer einzigen Anwendung verwalten möchten. Vergessen Sie nicht, dass CORS ebenfalls aktiviert sein muss.

Details zu den Eigenschaften finden Sie hier:

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