Можно ли префиксировать все пути в спецификации OpenAPI 2.0?

У меня есть спецификация Swagger для API, которая выглядит примерно так:

swagger: '2.0'
info:
  title: my-api
  description: My API
  version: v1
schemes:
  - https
produces:
  - application/json
paths:
  v1/entry/check:
    post:
      ...
  v1/entry/enter:
    post:
      ...
  v1/exit/leave:
    post:
      ...
...

Как видите, каждый путь в paths имеет префикс v1/, поскольку спецификация описывает версию v1 API (как вы также можете видеть в значении info.version).

Мне интересно, есть ли способ избежать повторения этого префикса, т.е. неявно префикс всех путей с v1/? В основном я хочу сделать это, чтобы избежать случайного неправильного использования спецификации, то есть полностью предотвратить добавление другого пути без префикса.

Документирование API с помощью Swagger на Springboot
Документирование API с помощью Swagger на Springboot
В предыдущей статье мы уже узнали, как создать Rest API с помощью Springboot и MySql .
2
0
151
1
Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

Ответ принят как подходящий

Вы можете указать префикс как basePath.

basePath: /v1
paths:
  /entry/check:
    ...
  /entry/enter
    ...

Это очень аккуратно - спасибо!

creativecreatorormaybenot 13.09.2022 11:05

Другие вопросы по теме