Расширения и аннотации Talend
Экспортируйте ваш API с расширениями или аннотациями Talend, чтобы сохранить выразительность, обеспечиваемую API Designer.
При экспорте API вы можете включить расширения Talend для спецификации OpenAPI или аннотации Talend для RAML. Они позволяют сохранить структуру вашего API в том виде, в котором она определена в API Designer.
Например, в 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"