Как изменить свойства Strapi API документации плагин swagger - PullRequest
Новая
       18

Как изменить свойства Strapi API документации плагин swagger

0 голосов
/ 11 ноября 2019

Я создал пользовательский API с именем auth / google, который проверяет Google tokenId и генерирует токен JWT для реакции переднего плана.

Теперь я хотел бы иметь настраиваемые свойства в API Swagger. В настоящее время он содержит {foo: "string"} в теле запроса и все ответы

Чтобы изменить это, я выполнил следующие шаги:

  1. создал user-permissions-Файл user.json в папке проекта / extensions / users-permissions / documentsmentations / 1.0.0 / overrides / users-permissions-User.json

, а затем добавлен ниже содержимого 

{
  "paths": {
    "/auth/google": {
      "post": {
        "deprecated": false,
        "description": "Login a user using the identifiers email and password",
        "responses": {
          "200": {
            "description": "response",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "tokenId": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "default": {
            "description": "unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "summary": "",
        "tags": [
          "Users-Permissions - User"
        ],
        "requestBody": {
          "description": "",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "tokenId": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
  "tags": [
    {
      "name": "Users-Permissions - User"
    }
  ]
}
}
Затем http://localhost:1337/admin/plugins/documentation нажал кнопку регенерации нажал кнопку открытия

Ничего не изменилось в документации. Было бы здорово, чтобы кто-нибудь помог мне сделать это

...