Документация API с Swagger - PullRequest
Новая
       50

Документация API с Swagger

0 голосов
/ 11 октября 2018

У меня есть проект на symfony4 с api-platform .Процесс входа в систему, описанный в security.yaml, выглядит следующим образом: 

security:
encoders:
    App\Entity\User: bcrypt
providers:
    our_db_provider:
        entity:
            class: App\Entity\User
            property: email
firewalls:
    ....
    login:
        pattern: ^/login
        stateless: true
        anonymous: true
        json_login:
            check_path: /login
            success_handler: lexik_jwt_authentication.handler.authentication_success
            failure_handler: lexik_jwt_authentication.handler.authentication_failure
            username_path: email
        logout:
            path:   /logout
            target: /
    api:
        pattern: ^/
        stateless: true
        guard:
            authenticators:
            - lexik_jwt_authentication.jwt_token_authenticator
        ....

Для всех моих моделей у меня есть довольно встроенный пользовательский интерфейс, а также я могу добавить некоторые атрибуты для него.Но как я могу описать запрос на вход?Я видел Swagger / Open API Support этот документ, но действительно ли я должен предоставить необработанный массив с описанием?Может быть, лучше сделать это в некоторых конфигурациях yaml для пользовательских страниц?И последний вопрос.Где я могу найти структуру для этого массива?

1 Ответ

0 голосов
/ 19 октября 2018

Поскольку это пользовательская точка входа с точки зрения библиотеки, вам нужно будет украсить генератор документации Swagger, как описано в этой записи документации, чтобы добавить определение точки входа в систему: https://api -platform.com/ docs / core / swagger / # overriding-the-swagger-Documentation

В настоящее время других решений нет.Было бы неплохо добавить новую опцию конфигурации, чтобы разрешить введение некоторых YAML (PR приветствуется!)

...