首页 文章

Swagger Springfox注释不起作用

提问于
浏览
0

这些是我正在尝试的示例应用程序的方法 Headers . 不幸的是,我没有看到@ApiOperation或@ApiResponse或@ApiResponses注释生效 . 我还有一个示例类和一个Application类(包含swagger配置信息等)

@Api(value = "/v1/", description = "Test API", produces = "application/json")
@RestController
@RequestMapping("/v1/")
class SampleRestController {

     @ApiResponses(value = {
            @ApiResponse(code = 200, message = "Successfully added"),
            @ApiResponse(code = 416, message = "List is empty") })
   @RequestMapping(produces = MediaType.APPLICATION_JSON_VALUE, value = "samples/{sb}",
    method = RequestMethod.GET)
   public Map<String, String> sbs(@PathVariable("sb") String sb) {

    }  

   @ApiOperation(
      value = "Seeing where this shows up",
      notes = "we should see this in the implememtation notes",
      response = Sample.class,
      httpMethod = "GET"
    )
        @ApiResponses(value = {
            @ApiResponse(code = 200, message = "Successfully added"),
            @ApiResponse(code = 416, message = "List is empty") })

   @RequestMapping(produces = MediaType.APPLICATION_JSON_VALUE, value = "samples/{pb}",
    method = RequestMethod.GET)
   public Sample ps(@PathVariable String pb) {

   }

   @RequestMapping(produces = MediaType.APPLICATION_JSON_VALUE, value = "samples",
    method = RequestMethod.GET)
   public Collection<Map<String, String>> cs(@RequestParam(value = "cid", required = true, defaultValue = "")
    String cid) {

   }


}

这是我招摇的json的相关部分

{"swagger":"2.0","info":{"description":"All about the Samples","title":"Samples API","contact":{},"license":{}},"host":"localhost:8080","basePath":"/","tags":[{"name":"sample-rest-controller","description":"Sample Rest Controller"}],



"paths":{


"/v1/samples":{"get":{"tags":["sample-rest-controller"],"summary":"cs","operationId":"csUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"cid","in":"query","description":"cid","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Collection«Map«string,string»»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},


"/v1/samples/{pb}":{"get":{"tags":["sample-rest-controller"],"summary":"ps","operationId":"psUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"pb","in":"path","description":"pb","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Sample"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},


"/v1/samples/{sb}":{"get":{"tags":["sample-rest-controller"],"summary":"sbs","operationId":"sbsUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"sb","in":"path","description":"sb","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object","additionalProperties":{"type":"string"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}}},

我正在使用springfox-swagger2版本2.1.1,我正在通过swagger在他们的现场演示应用程序提供的默认UI查看我的UI .

有人能告诉我我做错了什么吗?谢谢!

1 回答

  • 5

    我正在玩,并改变了我的导入

    import com.wordnik.swagger.annotations . ;

    import io.swagger.annotations . ;

    并且所有注释似乎都有效 . 那么,看起来com.wordnik.swagger.annotations导入不再有效,或者至少不能正常工作?

    由Dilip Krish确认here

相关问题