前言
对于开发人员来说,在开发过程中得自测是不可避免得,像postman这种工具就对模仿http申请提供了便捷。还有就是接口文档也是令人头疼得事件,Swagger就很好得解决了这种事件。
什么是Swagger?
Simplify API development for users, teams, and enterprises with the Swagger open source and professional toolset. Find out how Swagger can help you design and document your APIs at scale.
借助Swagger开源和业余工具集,为用户,团队和企业简化API开发。理解Swagger如何帮忙您大规模设计和记录API。
Swagger选用
因为Swagger官网的API文档界面不难看,所以就找到了swagger-bootstrap-ui,界面难看还能够自定义申请参数文档。 起初又找到了该团队开发的springboot版本,在原有的根底上加强,Get it !
官网文档地址:https://doc.xiaominfo.com/kni...
引入
<!-- Swagger --> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>2.0.8</version> </dependency>
3.x版本援用的是springfox3和OpenAPI3标准,目前是不稳固版本,所以抉择援用2.x的版本~~~~
配置
新建SwaggerConfig.java
@Configuration@EnableSwagger2WebMvcpublic class SwaggerConfig { @Bean(value = "api") public Docket defaultApi2() { Docket docket=new Docket(DocumentationType.SWAGGER_2) .apiInfo(new ApiInfoBuilder() .description("# 文档的形容") .version("1.0") .build()) //分组名称 .groupName("1.X版本") .select() //这里指定Controller扫描包门路 .apis(RequestHandlerSelectors.basePackage("com.ify.sampleAdmin.web.controller")) .paths(PathSelectors.any()) .build(); return docket; }}
应用
运行http://localhost:8181/sa/doc.html
。
。
。
。
待续