跳到主要内容

示例代码

目前Knife4j以及前身swagger-bootstrap-ui也提供了一些代码示例,可以前往Gitee仓库地址直接获取。

Demo示例地址:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo

主要模块说明:

模块说明
knife4j-spring-boot27-demoKnife4j 4.0基于OpenAPI2规范
knife4j-spring-boot3-demoKnife4j 4.0 基于OpenAPI3+Spring Boot 3.0
knife4j-openapi3-spring-boot3-webflux-demoKnife4j 4.0 基于OpenAPI3+Spring Boot 3+SpringWebFlux,参考说明
knife4j-openapi3-spring-webflux-demoKnife4j 4.0 基于OpenAPI3+Spring Boot 2+SpringWebFlux,参考说明
knife4j-springdoc-openapi-demoKnife4j 4.0 基于Spring Boot 2+OpenAPI3
knife4j-aggregation-disk-demoKnife4j提供的微服务聚合组件,Disk模式下聚合,可参考实战文档
knife4j-aggregation-cloud-demoKnife4j提供的微服务聚合组件,Cloud模式下聚合,可参考实战文档
knife4j-aggregation-eureka-demoKnife4j提供的微服务聚合组件,Eureka模式下聚合,可参考实战文档
knife4j-aggregation-nacos-demoKnife4j提供的微服务聚合组件,Disk模式下聚合,可参考实战文档
knife4j-springdoc-openapi-demo在Spring Boot单体架构下集成Knife4j,基于springdoc-openapi以及OpenAPIV3
knife4j-springfox-boot-v3-demo在Spring Boot单体架构下集成Knife4j,基于Springfox3以及OpenAPIv3
knife4j-spring-boot-demo在Spring Boot架构下集成knife4j的项目示例,主要是基于OpenAPIV2
knife4j-lower-spring-boot-demoSpring Boot低版本测试集成Knife4j,主要复测Bug使用。开发者可不用理会
knife4j-spring-boot-single-demo在Spring Boot单体架构下集成knife4j的项目示例
knife4j-spring-boot-fast-demoSpring Boot单体框架快速集成Knife4j示例,可参考文档快速开始
knife4j-spring-oauth2-authorization_codeKnife4j集成OAuth2.0的授权码模式,可参考实战文档
knife4j-spring-oauth2-implicitKnife4j集成OAuth2.0的简化模式,可参考实战文档
knife4j-spring-oauth2-client_credentialsKnife4j集成OAuth2.0的客户端模式,可参考实战文档
knife4j-spring-oauth2-passwordKnife4j集成OAuth2.0的密码模式,可参考实战文档
knife4j-spring-cloud-gateway在Spring Cloud微服务架构下通过gateway网集成knife4j的示例
knife4j-spring-boot2-demoSpring Boot 2.x系列版本集成Knife4j
knife4j-jfinal-demo在JFinal框架中集成Knife4j,目前正在开发中,该示例无效,开发者可不用理会
swagger-bootstrap-ui-demo-mvc在Spring MVC模式下集成swagger-bootstrap-ui
swagger-bootstrap-ui-demo在Spring Boot单体架构下集成swagger-bootstrap-ui
swagger-bootstrap-ui-gateway在Spring Cloud微服务架构下通过gateway网关集成swagger-bootstrap-ui
swagger-bootstrap-ui-zuul在Spring Cloud微服务架构下通过zuul网关集成swagger-bootstrap-ui