Swagger Editor, как добавить дополнительную «скрытую» информацию?

Question

Я использую редактор swagger, чтобы объявить некоторые из моих конечных точек маршрутизации общедоступным, однако я хотел бы добавить имя моей функции маршрутизатора (контролирующая функция) к моим путям конечной точки в качестве дополнительной информации, но просто как информация для меня ( частный). Например. чтобы узнать, какую функцию промежуточного программного обеспечения я использую для определенного маршрута. Это как-то возможно, если да, то как?

Answer 1

Прежде всего, в спецификации OpenAPI содержится ключевое слово operationId, которое некоторые инструменты сопоставляют с именами методов.

paths:
  /users:
    get:
      operationId: getUsers
      ...
    post:
      operationId: addUser
      ...

Вы также можете добавить произвольные пользовательские ключи с префиксом x- (так называемые свойства расширения ). Общее свойство расширения - x-swagger-router-controller для указания класса контроллера.

paths:
  /foo:
    x-swagger-router-controller: users