Интеграция Java + php Swagger

Question

Я добавил конфигурацию docket к своему java (весна mvc). Я хотел бы добавить в мои swagger ui конечные точки php /. Я подумал, что хороший способ сделать это - создать yaml в php -> создать json из этого и затем взять эти файлы в java. ресурсов. Затем, как я могу использовать это в моем досье в java. В досьете моя конфигурация состоит в том, что каждый контроллер, содержащийся в пути external, будет включен, но теперь я хочу взять все контроллеры с внешним и вызвать php (используя файлы json) с общим путём diffr enet Есть идеи?

Answer 1

Как добавить Swagger-UI в PHP Код сервера:

Во-первых, для всех Swagger UI требуется файл. json, где спецификации API написаны на OpenAPI l ie. Этот. json путь к файлу настраивается внутри индекса Swagger-UI. html. Файл index. html требует, чтобы код пакета Swagger был извлечен из NPM для его визуализации. Браузер будет отображать код вместе, создавая ваш SwaggerUI!

Установка (с Composer):

composer require zircote/swagger-php

Для использования в любом месте установите swagger- php глобально и убедитесь, что поместите каталог ~ / .composer / vendor / bin в вашу переменную PATH, чтобы ваша система могла найти исполняемый файл openapi.

composer global require zircote/swagger-php

Использование:

Добавить аннотации к php файлам.

/**
 * @OA\Info(title="My First API", version="0.1")
 */

/**
 * @OA\Get(
 *     path="/api/resource.json",
 *     @OA\Response(response="200", description="An example resource")
 * )
 */

Использование из php:

Создание постоянно обновляемой документации.

<?php
require("vendor/autoload.php");
$openapi = \OpenApi\scan('/path/to/project');
header('Content-Type: application/x-yaml');
echo $openapi->toYaml();

Использование из Интерфейс командной строки:

Генерирование документации в файл * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 10 * * * * * * * * * *. из строки json, что облегчает программное управление объектами.

<?php

use OpenApi\Serializer;

$serializer = new Serializer();
$openapi = $serializer->deserialize($jsonString, 'OpenApi\Annotations\OpenApi');
echo $openapi->toJson();

Использование из docker:

Создание документации swagger в состояние c json файл.

docker run -v "$PWD":/app -it tico/swagger-php --help

GitHub: https://github.com/zircote/swagger-php

Подробнее здесь: * 10 43 *https://medium.com/@tatianaensslin / как к надстройке чванство-щ-to php -server-код-f1610c01dc03