[ADP-759] OpenAPI: 聯絡資訊

指引

必須(MUST)在 info.contact 物件中提供聯絡資訊。
對於內部 API (受眾 <= COMPANY_INTERNAL)，必須(MUST)在 info.contact.name 欄位中指定團隊或業務單位名稱。
對於外部 API (受眾 >= PARTNER_EXTERNAL)，必須(MUST)在 info.contact.url 欄位中指定文件位置的 URL。
應該(SHOULD)在 info.contact.email 欄位中包含電子郵件地址以供支援之用，特別是對於外部 API (受眾 >= PARTNER_EXTERNAL)。
應該(SHOULD)在 info.contact.description 欄位中提供清晰簡潔的聯絡人角色或目的描述。

範例

yaml

openapi: 3.1.0
info:
  title: 範例 API
  description: 這是一個範例 API。
  version: 1.0.0
  contact:
    name: API 支援團隊
    url: https://document.site/support
    email: support@example.com
    description: 有關此 API 的任何查詢

相關 ADP

參考資料