在Swagger UI中生成示例示例（在Spring引導項目中）

我正在使用Spring引導應用程序並使用Swagger UI進行了配置。在Swagger UI中生成示例示例（在Spring引導項目中）

我想知道我們是否可以用樣本值預先填充示例值，以便我們可以點擊「試用它！」按鈕，而不必輸入一些樣本值來獲得響應。

它必須存在那裏。

有沒有一種方法可以使用Swagger使用的註釋或單獨的文件來做到這一點？

我使用springfox-swagger2：2.7.0和springfox-swagger-ui：2.7.0的spring引導項目，並使用gradle添加了依賴項。

來源

2017-06-15 anu l

由於@ApiParam屬性example和examples不起作用（請參閱this issue on GitHub），因此對添加示例的支持是有限/不存在的。

你可以簡單的參數（@RequestParam）做的是與defaultValue屬性添加了註釋@ApiParam，像這樣：

@GetMapping 
public List<Foo> findAll(
     @RequestParam(required = false) 
     @ApiParam(defaultValue = "foo") // Put the default value here 
     String input) { 
    // ... 
}

然而，沒有支持但與@RequestBody參數做這個。

@RequestBody參數的一個可能的解決方法是通過單擊Swagger測試儀右側的代碼框，它說示例值。如果您點擊它，它會將該示例插入到字段中。

來源

2017-06-15 07:16:14 g00glen00b

謝謝，我會研究它。同時我剛剛閱讀了關於swashbuckle https://mattfrear.com/2015/04/21/generating-swagger-example-responses-with-swashbuckle/，但它似乎只適用於.NET。任何可用於Java Spring的東西。 –

很確定Springfox是爲Spring生成Swagger文檔的最佳方法。 – g00glen00b

通過插件使用示例很容易。但對於你的需要@ g00glen00b的建議將工作很好！ –

在Swagger UI中生成示例示例（在Spring引導項目中）

回答

相關問題