swagger配置使用说明.docxVIP

swagger 配置使用说明 1、系统使用swagger-springmvc 0.6.6版本，后续版本系统spring无法支持。 2、相关pom配置 dependency groupIdcom.mangofactory/groupId artifactIdswagger-springmvc/artifactId version0.6.6/version exclusions exclusion artifactIdservlet-api/artifactId groupIdjavax.servlet/groupId /exclusion exclusion artifactIdspring-webmvc/artifactId groupIdorg.springframework/groupId /exclusion exclusion artifactIdspring-web/artifactId groupIdorg.springframework/groupId /exclusion /exclusions /dependency dependency groupIdorg.springframework/groupId artifactIdspring-core/artifactId version3.1.0.RELEASE/version /dependency dependency groupIdorg.springframework/groupId artifactIdspring-beans/artifactId version3.1.0.RELEASE/version /dependency 3、系统配置文件 a、 ， 设置系统根路径和API版本 b、wf-app-swagger.xml 设置需要查看的URI util:list id=swaggerArrowUri list-class=java.util.ArrayList value-type=java.lang.String value/app/../value value/appserver/../value value/user/value value/txt/demo/value /util:list /..为通配符，支持子路径模糊匹配 4、类上加API注解 对contorller类添加API注解 类的头部添加@API注解 类的方法上添加@ApiOperation注解 @Api(value = 用户, description = 有关于用户的CURD操作 ) @Controller @RequestMapping(/user) public class TestController { @ResponseBody @RequestMapping(value = /addUser, method = RequestMethod.GET, produces = application/json; charset=utf-8) @ApiOperation(value = addUser, notes = This can only be done by the logged in user. ,responseClass=String.class) public String addUser(@ApiParam(required = true, name = postData, value = 用户信息json数据) @RequestParam( value = postData) String postData, HttpServletRequest request)throws JSONException { JSONObject json = new JSONObject(); json.put(postData, postData); return json.toString(); } ... ...} @API表示一个开放的API，可以通过description简要描述该API的功能。 在一个@API下，可有多个@ApiOperation，表示针对该API的CRUD操作。在ApiOperation Annotation中可以通过value，notes描述该操作的作用，