2015-07-21 152 views
0

这些是我试图创建的示例应用程序的方法标题。不幸的是,我没有看到@ApiOperation或@ApiResponse或@ApiResponses注解生效。 我也有一个示例类和应用类(包含招摇配置信息等)Swagger Springfox注释不起作用

@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查看我的用户界面。

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

回答

5

我打得周围,改变了我的进口从

进口com.wordnik.swagger.annotations;

import io.swagger.annotations .;

和所有注释似乎工作。 那么,看起来像com.wordnik.swagger.annotations导入不再起作用,或者至少不能正常工作?

由Dilip Krish确认here