java - Swagger 不选择空值的方法

Question

我正在使用 swagger 来记录我的其余 api。

一个例子:

@RequestMapping(value = "/abc/api/fruit", produces = "application/json")
@Controller
@Api(value = "Fruit", description = "api for fruits", produces =  "application/json")
public class FruitResource {

@RequestMapping(method = RequestMethod.GET, value = "")
@ResponseBody
@ApiOperation(httpMethod = "GET", value = "Resource to get fruits", produces = "application/json", notes = "get fruits", response=Fruit.class)
public ResponseEntity<Fruit> getFruits() throws Exception {
    return new ResponseEntity<Fruit>(someServiceCallToGetFruits(), HttpStatus.OK);
}
}

如上所示，该方法上方 RequestMapping 中的 value 为空 ("")。

因此，这个类和方法没有被 swagger 选中。

但是当我将上面方法的 RequestMapping 行更改为如下时:

@RequestMapping(method = RequestMethod.GET, value = "/")

它开始工作了。

这是一个错误吗？如何使 swagger 能够使用 "" 路径值。我不想将 "/" 放在所有此类方法之上。

Answer 1

如果您不想为特定方法添加扩展 API 路径，则无需显式指定空值。相反，可以使用以下注释:

@RequestMapping(method = RequestMethod.GET)

甚至

@GetMapping()