簡體   English   中英

使用注釋的 Swagger 文檔示例模型自定義

[英]Swagger document example model customization using annotations

我正在處理 swagger 文檔,並希望在 POST 請求中自定義示例模型。 此請求采用 JSON 正文,其中包含某些參數。 我想刪除一些參數並為其他參數設置默認值。 我應該使用哪些注釋以及在哪里?

目前默認的身體顯示為

[
  {
    "height": 0,
    "day": 0,
    "decimalYear": 0,
    "fyear": 0,
    "elevation": 0,
    "azimuth": 0,
    "month": 0,
    "year": 0
  }
]

我希望身體像

[{
    "elevation": 28,
    "azimuth": -61, 
    "height": 81555, 
    "year": 1965, 
    "month": 11,
    "day":8
}]

要添加默認值,您可以使用@RequestParam(defaultValue = "sample")和可選嬰兒車使用@RequestParam(required = false) 文檔

歡迎使用堆棧溢出。

我相信你應該去 API Operation 並按照鏈接中提到的進行操作

https://github.com/swagger-api/swagger-core/wiki/Annotations

您可以根據需要操作值,注解需要在控制器層使用

暫無
暫無

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

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