PHP Lang
  1. PHP Lang
  3. Как использовать ссылки на примеры Swagger?
Intereting Posts
Jquery ajax, данные с src изображения IIS WordPress, вызывающий ошибку Curl 18 Как получить все последние вставленные идентификаторы строк в mysql-php? Twig для цикла и массива с ключом Понимание ограничителя кеша | заголовки уже отправили php-предупреждение Метод заполнения в Laravel не работает? Анализ XML с использованием XSD в PHP полная обработка ошибок SQL Загрузка и отправка формы Php Pusher отправляет событие присутствия конкретному участнику Не удается закрыть соединения ODBC $ subject в почтовой форме php, возвращающей только первое слово в строке $ _SERVER возвращает путь с повторным именем каталога AngularJS потоковое аудио с сервера PHP 2 Как отделить имя файла от пути? basename () и preg_split () с array_pop ()

Как использовать ссылки на примеры Swagger?

Спецификация JSON: 

"responses": { "200": { "description": "Успешный ответ сервиса", "schema": { "$ref": "#/definitions/BaseResponse" }, "examples": { "application/json": { "status": true, "response": { "$ref": "#/definitions/Product" }, "errors": null } } } }

Результат: введите описание изображения здесь

Но мне нужно: 

 { "status": true, "response": { "ProductNumber": "number", "Barcode": "number", "Length": 12, "Width": 34, "Height": 423, "Volume": 1232 } }, "errors": null }

Как я могу использовать $ refs в массиве example для ответа на специальный формат? Это типичный случай, но я не могу найти для него документацию. Благодарим вас за отзыв.

    Примеры Inline не поддерживают $ref – пример должен быть полным примером: 

      "responses": { "200": { "description": "Успешный ответ сервиса", "schema": { "$ref": "#/definitions/BaseResponse" }, "examples": { "application/json": { "status": true, "response": { "ProductNumber": "number", "Barcode": "number", "Length": 12, "Width": 34, "Height": 423, "Volume": 1232 }, "errors": null } } } }

    Вместо использования responses.<code>.examples вы можете указать значения примера в своей схеме BaseResponse , и пользовательский интерфейс Swagger будет использовать их вместо этого.

    Например, вы можете добавить полный пример в свою схему BaseResponse : 

      "definitions": { "BaseResponse": { "type": "object", "properties": { "status": { "type": "boolean" }, ... }, "example": { // <------ schema-level example "status": true, "response": { "ProductNumber": "number", "Barcode": "number", "Length": 12, "Width": 34, "Height": 423, "Volume": 1232 }, "errors": null } } }

    или используйте примеры уровня собственности: 

      "definitions": { "BaseResponse": { "type": "object", "properties": { "status": { "type": "boolean", "example": true // <------ }, "response": { "$ref": "#/definitions/Product" }, "errors": { "example": null // <------ } } }, "Product": { "type": "object", "properties": { "ProductNumber": { "type": "string", "example": "number" // <------ }, "Length": { "type": "integer", "example": 12 // <------ }, ... } } }

    Я хотел бы отметить, что "errors": null и "example": null в действительности не действительны в OpenAPI 2.0 (fka Swagger), поскольку он не поддерживает типы с нулевым значением. Нулевые типы поддерживаются только в OpenAPI 3.0.