Home
REST-описания OpenAPI
Требования к спецификации
Для создания REST-сервиса требуется спецификация OpenAPI 3.0.1 в форматах YAML или JSON.
Вы можете использовать редактор OpenAPI для удобного создания и редактирования спецификаций.
В OpenAPI спецификации при использовании Swagger UI используются зарезервированные ключевые слова:
("object", "list", "file", "localVarPath", "localVarQueryParams", "localVarCollectionQueryParams", "localVarHeaderParams", "localVarCookieParams", "localVarFormParams", "localVarPostBody", "localVarAccepts", "localVarAccept", "localVarContentTypes", "localVarContentType", "localVarAuthNames", "localReturnType", "ApiClient", "ApiException", "ApiResponse", "Configuration", "StringUtil", "abstract", "continue", "for", "new", "switch", "assert", "default", "if", "package", "synchronized", "boolean", "do", "goto", "private", "this", "break", "double", "implements", "protected", "throw", "byte", "else", "import", "public", "throws", "case", "enum", "instanceof", "return", "transient", "catch", "extends", "int", "short", "try", "char", "final", "interface", "static", "void", "class", "finally", "long", "strictfp", "volatile", "const", "float", "native", "super", "while", "null").
Если вам в API-схеме необходимо использовать какое-либо из этих слов, обратите внимание, что в Swagger UI оно будет автоматически переименовано для соответствия стандартам OpenAPI. Переименование отразится только в интерфейсе Swagger и не приведет к функциональным изменениям в самом API.
| Для формирования ответов с большими объемами данных в REST-сервисах рекомендуется использовать сохраненные FTL-шаблоны, а не вписывать текст непосредственно в маршрут. |
| XML-провайдер в Entaxy ION не поддерживает корректную обработку схем, использующих дополнительные свойства (additionalProperties). |
Загрузка спецификации
|
Имя загружаемого файла не должно содержать пробелов. |
Для создания REST-сервиса файл спецификации необходимо загрузить на платформу:
| В случае ошибок с загрузками описаний сервисов (wsdl, openapi) необходимо удалить одноименную служебную папку из подраздела 'service-resources' или перезагрузить описание сервиса с новым именем. |
