簡體   English   中英

是否可以在 OpenAPI 2.0 規范中為所有路徑添加前綴?

[英]Is it possible to prefix all paths in an OpenAPI 2.0 spec?

我有 API 的 Swagger 規范,看起來像這樣:

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/為前綴,因為規范描述了 API 的v1版本(您也可以在info.version值中看到)。

我想知道,有沒有辦法避免重復這個前綴,即隱式地為所有路徑添加前綴v1/ 主要是,我想這樣做是為了避免任何意外濫用規范,即完全防止添加另一個沒有前綴的路徑。

您可以將前綴指定為basePath

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

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM