生活不易,且行且学习吧
接口这种东西,还是在项目初期定好规范在写比较好,尤其是文档,一定要及时更新,曾经接手过一个老项目,一个文档也没有,非常棒,只能去读代码,全是坑,欲仙欲死。Swagger配置好能省不少事情。
1,配置Swagger,引入包
<swagger.version>2.6.1</swagger.version><dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>${swagger.version}</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>${swagger.version}</version> </dependency>
2,创建swagger配置类SwaggerConfig
/** * Swagger配置 */ @Configuration public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.dbldt.filemanager.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("SpringBoot文件管理系统") .description("试验品") .termsOfServiceUrl("https://gitee.com") .version("version 1.0") .build(); } }
添加@EnableSwagger2注解
启动,浏览器访问,http://localhost:8080/swagger-ui.html
写个接口测试下
@RequestMapping("/testSwagger") @ApiOperation(value="测试swagger", notes="测试swagger") @ApiImplicitParam(name = "params", value = "数据传入json串", required = true, dataType = "Map") @ResponseBody public String testSwagger(@RequestBody Map params) { String backStr = params.get("backStr").toString(); return "你的传入参数为:"+backStr; }
传入参数
以后的接口可以参照写法。