Пользовательский сваггер платформы Api Platform / тело контекста openapi - PullRequest
0 голосов
/ 23 октября 2019

Я использую Api Platform с Symfony 4 и хочу создать собственную конечную точку. Все работает нормально, но я не могу изменить 2 вещи: тело и формат ответа (в документации openapi).

Параметры и коды состояния ответов работают просто отлично.

*          "login"={
 *              "route_name"="api_login",
 *              "method" = "post",
 *              "openapi_context" = {
 *                  "parameters" = {},
 *                  "body" = {
 *                      "description" ="Username and password",
 *                      "schema" = {
 *                          "type" = "object",
 *                          "required" = {"email","password"},
 *                          "properties" = {
 *                                   "email" = {
 *                                      "type" = "string"
 *                                   },
 *                                   "password" = {
 *                                      "type" = "string"
 *                                   }
 *                          }
 *                      }
 *                  },
 *                  "responses" = {
 *                      "200" = {
 *                          "description" = "User logged in",
 *                          "schema" =  {
 *                              "type" = "object",
 *                              "required" = {
 *                                  "token",
 *                                  "refresh_token"
 *                              },
 *                              "properties" = {
 *                                   "token" = {
 *                                      "type" = "string"
 *                                   },
 *                                   "refresh_token" = {
 *                                      "type" = "string"
 *                                   }
 *                              }
 *                          }
 *                      },
 *                      "401" = {
 *                          "description" = "invalid password or email"
 *                      }
 *                  },
 *                  "summary" = "Login user in application",
 *                  "consumes" = {
 *                      "application/json",
 *                      "text/html",
 *                   },
 *                  "produces" = {
 *                      "application/json"
 *                   }
 *              }
 *          }

1 Ответ

0 голосов
/ 24 октября 2019

Взгляните на этот ответ по проблеме api-платформы (документация здесь действительно красиво отформатирована в yaml вместо того, чтобы хранить их в php-массивах, неплохая идея) и прочитайте документы , они, вероятно, помогут Вам оформить документацию любым способом.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...