有趣生活

当前位置:首页>科技>swagger editor怎么编写api文档快来试试这款强大的在线API工具

swagger editor怎么编写api文档快来试试这款强大的在线API工具

发布时间:2026-07-21阅读(0)

导读将开源小分队设为星标精品文章第一时间读大家好,我是可爱又机灵的开源小妹。今天给大家分享一个非常好用的在线文档工具:Knife4j背景现在分工越来越明确,做项....

开源小分队设为星标 精品文章第一时间读

大家好,我是可爱又机灵的开源小妹。

今天给大家分享一个非常好用的在线文档工具:Knife4j

背景

现在分工越来越明确,做项目也都是前后端分离,这样就和前端沟通越来越多,包括现在微服务架构也越来越流行,服务就会进行拆分,各个服务之间有不同的团队开发,这个时候一份简洁完善的在线API接口就很有必要了,可以提提高大家的工作效率,减少一些不必要的沟通。Knife4j就是在线API文档的佼佼者,不仅提供了美观的在线API文档,还有其他的一些特性例如:全局参数、个性化设置、资源安全等,大家跟着小妹一块来看看吧。

快速入门

加入依赖

<dependency><groupId>com.github.xiaoymin</groupId><artifactId>knife4j-spring-boot-starter</artifactId><version>2.0.9</version></dependency>

简单配置

@Configuration@EnableSwagger2WebMvcpublic class KnifeConfiguration {@Beanpublic Docket createRestApi {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo).groupName("V1版本").select.apis(RequestHandlerSelectors.withClassAnnotation(Api.class)).paths(PathSelectors.any).build;}private ApiInfo apiInfo {return new ApiInfoBuilder.title("Knife Simple Demo APIs").description("Knife Simple Demo").version("1.0").build;}}

访问地址:http://localhost:8080/doc.html,其中端口是自己服务的端口信息,小妹这边配置的是8080端口

TAGS标签:  swagger  editor  怎么  编写  文档  swagger ed

Copyright © 2024 有趣生活 All Rights Reserve吉ICP备19000289号-5 TXT地图HTML地图XML地图