Как сгенерировать swagger через консоль?

Question

[ganjo888]

Делаю документацию на swagger мой код использую библиотеку Swagger-PHP

/**
 * @OA\Info(
 *     version="1.0",
 *     title="Parser images links"
 * )
 */
/**
 * @OA\Get(
 *     path="/images",
 *     summary="Get links images",
 *         @OA\MediaType(
 *             mediaType="application/json",
 *             @OA\Schema(
 *                 @OA\Property(
 *                     property="url",
 *                     type="string"
 *                 ),
 *                 example={"url": "http://okozorko.ru"}
 *             )
 *     ),
 *     @OA\Response(
 *         response=200,
 *         description="Successful operation"
 *     ),
 *     @OA\Response(
 *         response=404,
 *         description="Not found"
 *     ),
 *     @OA\Response(
 *         response= 400,
 *         description="Bad Request"
 *     ),
 * )
 */

как сделать, чтобы файл swagger.yml формировался через консоль? То есть , я ввожу команду путь и у меня выводится swagger.yml

Comments

[Максим Федоров]

https://github.com/zircote/swagger-php#usage-from-...

[ganjo888]

Максим Федоров, я видел документацию . но не понял ничего, какую команду указать? ./vendor/bin/openapi --help ?? где пути прописывать?

[ganjo888]

Максим Федоров, можно хороший и простой пример?

[Максим Федоров]

ganjo888, как так? :) из папки проекта в терминале -- куда композер ставили и находится папка  vendor

[ganjo888]

Максим Федоров, Попробую внятнее объяснить
вот мой скрипт

$rout->respond('GET', '/openapi', function () {

    $openapi = \OpenApi\scan("api");
});
$rout->dispatch();

что мне нужно сделать и что прописать , чтобы сформировался swagger.yml в папке api ?

[Максим Федоров]

ganjo888,

Не использовал, но прочитал в доке:

1. Вы можете в входной точке своего приложения указать путь к проекту, в файлах которых он будет искать аннотации и собирать в единую доку
zircote.com/swagger-php/Getting-started.html#usage

2. Вы можете запускать из консольной команды, запустите ее из корня проекта (должен на выходе json получиться), как понимаю он берет папку проекта за входной параметр... но вы введите --help

[ganjo888]

Максим Федоров, --help выводит

Options:
  --output (-o)     Path to store the generated documentation.
                    ex: --output openapi.yaml
  --exclude (-e)    Exclude path(s).
                    ex: --exclude vendor,library/Zend
  --bootstrap (-b)  Bootstrap a php file for defining constants, etc.
                    ex: --bootstrap config/constants.php
  --processor       Register an additional processor.
  --format          Force yaml or json.
  --debug           Show additional error information.
  --help (-h)       Display this help message.

я ввожу ./vendor/bin/openapi --output api/openapi.yaml
но он пишет ошибку Error: Specify at least one path.
как правильно ввести путь?

[Максим Федоров]

ganjo888, попроубйте api

[ganjo888]

Максим Федоров, увы.ошибка та же(

[ganjo888]

разобрался ./vendor/bin/openapi api -o api

Answer 1

[Eressleep]

Добрый день ! Если используете zircote/swagger-php

<Путь до пакета>/vendor/bin/openapi -o <Куда сохранить>swagger.yaml <Путь к аннотациям>/api/