Springdoc พร้อม api-docs หลายรายการ

Aug 31 2020

ฉันต้องการจัดกลุ่มเอกสาร API สามชุดในหนึ่ง swagger-ui ฉันใช้ Springdoc API-docs แต่ละรายการมี url ของตัวเอง (ไม่ได้อยู่ในโครงการเดียวกัน) มีวิธีทำไหม?

แก้ไข: ตอนนี้กำลังทำงานในลักษณะนี้:

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

คำตอบ

2 brianbro Aug 31 2020 at 21:30

คำตอบมีอยู่แล้วในคำถามที่พบบ่อย:

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

คุณสมบัติ springdoc.swagger-ui.urls. * เหมาะสำหรับกำหนดค่าภายนอก (/ v3 / api-docs url):

  • ตัวอย่างเช่นหากคุณต้องการตกลงจุดสิ้นสุดของบริการอื่น ๆ ทั้งหมดภายในแอปพลิเคชันเดียว อย่าลืมว่าต้องเปิดใช้ CORS ด้วย

ดูรายละเอียดคุณสมบัติได้ที่นี่:

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