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

У меня есть проект на symfony4 с апи-платформа.
Процесс входа, описанный в 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этот документ, но это действительно я должен предоставить необработанный массив с описанием? Может быть, лучше сделать это в некоторых конфигурациях yaml для пользовательских страниц? И последний вопрос. Где я могу найти структуру для этого массива?

0

Решение

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

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

1

Другие решения

Других решений пока нет …

По вопросам рекламы [email protected]