Talend 확장 및 주석
API Designer에서 제공하는 표현력을 유지하려면 Talend 확장 또는 주석과 함께 API를 내보내기하십시오.
API를 내보내기할 때 OpenAPI 사양에 대한 Talend 확장 또는 RAML에 대한 Talend 주석을 포함하도록 선택할 수 있습니다. 이를 통해 API Designer에 정의된 대로 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"