大家在进行Java学习的时候,也要学习一些API工具的使用。目前市场有哪些比较优秀的接口文档管理工具呢?Swagger Api接口文档工具到底如何,大致汇总一下吧!
1.Swagger
说到Swagger,他确实是为开发者发明的一款神器,他可以实现自动生成 API 接口文档,在线调试,非常的方便。Swagger 官方文档: https://swagger.io/。 项目接入: pom依赖:
io.springfoxgroupId> springfox-swagger2artifactId> 2.4.0version> dependency> io.springfoxgroupId> springfox-swagger-uiartifactId> 2.4.0version> dependency>
配置信息:
@Configuration@EnableWebMvc@EnableSwagger2public class SwaggerConfig extends WebMvcConfigurerAdapter { @Bean public Docket buildDocket() { Docket docket = new Docket(documentationType.SWAGGER_2) .apiInfo(buildApiInf()); docket = docket.select() .apis(RequestHandlerSelectors.any())//controller路径 .paths(PathSelectors.any()).build(); return docket; } @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler(“swagger-ui.html”) .addResourceLocations(“classpath:/meta-INF/resources/”); registry.addResourceHandler("/webjars @ApiOperation(value=“更新商户信息”, notes=“根据Customer对象更新,SON格式:{“id”:1,“customerType”:”…",…}") @ApiImplicitParam(name = “Json”, value = “”, dataType = “Json”,required = true) @ResponseBody @RequestMapping(value=“update”, method=RequestMethod.POST, produces = {“application/json;charset=UTF-8”}) public JSonObject updateCustomer(HttpServletRequest request) throws Exception{ //TODO 代码逻辑 }}
启动项目,打开swagger,界面:http://192.168.1.101:9001/swagger-ui.html,



