使用SpringMVC怎么对Swagger进行整合-创新互联
这篇文章将为大家详细讲解有关使用SpringMVC怎么对Swagger进行整合,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。
创新互联成立于2013年,先为即墨等服务建站,即墨等地企业,进行企业商务咨询服务。为即墨企业网站制作PC+手机+微官网三网同步一站式服务解决您的所有建站问题。配置
1、引入相关jar包:
io.springfox springfox-swagger2 2.7.0 io.springfox springfox-swagger-ui 2.7.0
2、创建java配置类
@Configuration @EnableSwagger2 public class Swagger2 { private ApiInfo apiInfo() { return new ApiInfoBuilder() // 文档标题 .title("wish") // 文档描述 .description("https://github.com/handexing").termsOfServiceUrl("https://github.com/handexing") .version("v1") .build(); } @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() // 指定controller存放的目录路径 .apis(RequestHandlerSelectors.basePackage("com.wish.controller")) .paths(PathSelectors.any()) .build(); } }
3、编写接口文档测试
@RequestMapping(value = "testSawgger", method = RequestMethod.POST, produces = "application/json; charset=utf-8") @ApiOperation(value = "测试swagger", httpMethod = "POST", notes = "testSawgger") public ExecuteResultaddUser(@ApiParam(value = "参数", required = true) Long id) { ExecuteResult result = new ExecuteResult (); try { result.setSuccess(true); } catch (Exception e) { result.setSuccess(false); } return result; }
说明:
@ApiOperation:用在方法之上
1、value: 表示接口名称
2、notes: 表示接口详细描述
3、httpMethod:表示接口请求方法类型
@ApiParam:用在方法参数上
1、required:表示参数是否必须传
2、name:表示参数名称
3、value:表示参数描述
关于使用SpringMVC怎么对Swagger进行整合就分享到这里了,希望以上内容可以对大家有一定的帮助,可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到。
本文名称:使用SpringMVC怎么对Swagger进行整合-创新互联
网页链接:http://hbruida.cn/article/hgpdc.html