l5-swagger-bootstrap-ui

[![Последняя версия на Packagist][ico-version]][link-packagist] [![Общее количество загрузок][ico-downloads]][link-downloads] ![Лицензия на программное обеспечение][ico-license]

Введение

l5-swagger-bootstrap-ui — это реализация фронтенда пользовательского интерфейса (UI) для Swagger. Цель проекта — заменить стандартную реализацию UI Swagger-UI и сделать документацию более удобной.

l5-swagger-bootstrap-ui является только реализацией UI для Swagger и не заменяет его функциональность, поэтому бэкенд-модули по-прежнему зависят от Swagger, и для достижения эффекта необходимо использовать аннотации Swagger.

Объявление

Фронтенд пользовательского интерфейса l5-swagger-bootstrap-ui реализован с использованием Bootstrap. Логика JavaScript основана на проекте https://github.com/xiaoymin/Swagger-Bootstrap-UI, который получил разрешение автора.

Проект зависит от https://github.com/DarkaOnLine/L5-Swagger, при установке l5-swagger-bootstrap-ui, L5-Swagger устанавливается автоматически. Конфигурация L5-Swagger и генерация файла api-docs.json описаны в документации L5-Swagger[https://github.com/DarkaOnLine/L5-Swagger/blob/master/README.md].

Установка

• Сначала необходимо добавить пакет x-class/l5-swagger-bootstrap-ui в composer:

  composer require x-class/l5-swagger-bootstrap-ui.

• В версиях Laravel >= 5.5 пакет будет автоматически ссылаться на Provider.

• Необходимо запустить команду publish для L5-Swagger, чтобы создать файл конфигурации:

  php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider".

• Затем запустите команду publish для l5-swagger-bootstrap-ui, чтобы создать файлы представлений:

  php artisan vendor:publish --provider "L5SwaggerBootStrapUi\L5SwaggerBootStarpUiServiceProvider".

• Наконец, в соответствующем файле контроллера напишите комментарии Swagger, а затем выполните команду для создания файла api-docs.json:

  php artisan l5-swagger:generate.

• Откройте браузер по адресу http://youdomain/api/documentation, чтобы получить доступ к документации. Если вы хотите изменить адрес или другие настройки, обратитесь к документации L5-Swagger[https://github.com/DarkaOnLine/L5-Swagger/blob/master/README.md].

Примечание

При создании файла api-docs.json могут возникнуть ошибки, связанные с зависимостями L5-Swagger. Если ваша версия swagger-php>=3.0, измените файл .env, добавив строку SWAGGER_VERSION=3.0. Или измените значение 2.0 на 3.0 в файле config/l5-swagger.php:

'swagger_version' => env('SWAGGER_VERSION', '3.0'),.

Если ваша версия swagger-php<3.0 или вы используете старый синтаксис @SWG (аннотации SWAGGER), установите старую версию swagger-php:

composer require 'zircote/swagger-php:2.*'.

Функции

• Документация по интерфейсу с примерами изображений:

.

• Функция онлайн-отладки с примером изображения:

Swagger введение

Swagger — это стандарт и полная структура для генерации, описания, вызова и визуализации RESTful-сервисов в стиле Web. Общая цель состоит в том, чтобы клиент и файловая система обновлялись с той же скоростью, что и сервер. Методы, параметры и модели тесно интегрированы с кодом на стороне сервера, позволяя API всегда оставаться синхронизированным. Swagger делает развёртывание, управление и использование мощных API проще, чем когда-либо.

Пример стандартного интерфейса Swagger-UI:

.