УСТАНОВКА SWAGGER PHP
Swaggeг позволяет создавать и визуализировать документацию API. Здесь описывается установка Swagger для использования с PHP.
Вам нужно установить пакеты swagger-php и swagger-ui. Вы можете использовать composer для установки пакетов.
"require": {
"zircote/swagger-php": "^3.0",
"swagger-api/swagger-ui": "^3.52"
}
Если вы хотите установить эти пакеты глобально, вы можете использовать следующую команду:
composer global require zircote/swagger-php swagger-api/swagger-ui
После установки пакетов вам нужно сгенерировать OpenAPI спецификацию с помощью команды:
./vendor/bin/openapi ./path/to/your/controllers -o ./swagger.json
Где "./path/to/your/controllers" - это путь к вашим контроллерам, "./swagger.json" - это путь, в который будет сохранен файл спецификации.
Теперь вы можете открыть файл index.html
, который находится в swagger-ui/dist
, в браузере вашего выбора и ввести URL-адрес, по которому вы можете получить спецификацию. Например, если вы сохранили файл в корневой папке вашего проекта и используете веб-сервер PHP в качестве локального сервера для разработки, ваш URL-адрес может выглядеть так:
http://localhost:8080/swagger.json
Swagger будет использовать спецификацию для генерации документации API.
Documenter son API PHP avec OpenAPI (Swagger)
How to Setup Swagger in Laravel Application
Swagger documentation for php api - Complete crud documentation using swagger [Super easy] 2022
How to setup Swagger with InfyOm Laravel Generator
Install Swagger UI Documentation for Your PHP RESTful API, Part 3 - #30
using swagger to generate documentation for laravel 8
Spring boot 3 - OpenApi Documentation - Swagger UI
Laravel и Swagger/OpenAPI