Talend 延伸和註解 | Qlik Cloud 說明
跳到主要內容

Talend 延伸和註解

使用 Talend 延伸或註解匯出您的 API,以保留 API Designer 提供的表達能力。

匯出 API 時,您可以選擇包含 OpenAPI 規範的 Talend 延伸,或 RAML 的 Talend 註解。這些可讓您保留在 API Designer 中定義的 API 結構。

例如,在 Contacts API 中,資源和作業會分類到各個區段中,並使用文字區塊來新增資訊。

Contacts API 的螢幕擷取畫面。

如果您在沒有 Talend 延伸或註解的情況下匯出此定義,則不會匯出區段和文字區塊。但是,若使用延伸或註解,它們將會包含在程式碼中。

區段資訊會新增至區段中包含的任何元素:

    x-talend:
      section: "Companies"

文字區塊會新增至檔案結尾:

  texts:
    3a36b8ba-2969-46f0-a36e-9d715eeece36:
      title: "Authentication"
      content: "This API is secured using Basic Authentication.\n\nAll **read operations are open** and don't require authentication. However, all **write operations require authentication**. "
      section: "General"
    612e4b7f-0530-4835-8a47-f580869c67df:
      title: "Error handling"
      content: "This API uses standard HTTP status codes to indicate the status of a response.\n\nThere are two main categories of error responses. Each have a different response payload structure.\n\n* Simple errors\n* Detailed errors\n\n\n# Simple errors\n\n| Name | Code | Description |\n| -------- | -------- | -------- |\n| Bad request     | 400     | The request was unacceptable     |\n| Unauthorized     | 401     | The request has not been applied because it lacks valid authentication credentials for the target resource.     |\n| Forbidden     | 403     | The server understood the request, but is refusing to fulfill it     |\n| Not Found     | 404     | The server has not found anything matching the request URI     |\n| Not acceptable     | 406     | The server is unable to return a response in the format that was requested by the client     |\n| Unsupported Media Type     | 415     | The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method     |\n| Too many requests     | 429     | Too many requests hit the API too quickly     |\n| Server error     | 500     | A technical error occured  |\n\n\n\n\n\n\n# Detailed errors\n| Name | Code | Description |\n| -------- | -------- | -------- |\n| Unprocessable entity     | 422     | The server understands the content type of the request entity, and the syntax of the request entity is correct, but was unable to process the contained instructions.     |\n\n\n\n\n"
| Server error     | 500     | A technical error occurred  |\n\n\n\n\n\n\n# Detailed errors\n| Name | Code | Description |\n| -------- | -------- | -------- |\n| Unprocessable entity     | 422     | The server understands the content type of the request entity, and the syntax of the request entity is correct, but was unable to process the contained instructions.     |\n\n\n\n\n"
      section: "General"

此頁面是否對您有幫助?

若您發現此頁面或其內容有任何問題——錯字、遺漏步驟或技術錯誤——請告知我們!