http://ip:port/doc.html
Swagger
Java代码和Ui都混合在一个Jar包,单体架构项目引入即可使用
使用demo
https://gitee.com/xu_yuchun/construct-framework/tree/master/version/v1.1
- 项目运行后访问
http://localhost:ip/swagger-ui.html
http://localhost:ip/项目名/swagger-ui.html
http://localhost:ip/swagger-resources/configuration/ui
注意:项目如果有拦截器 可能拦截swagger-ui.html及相关请求
knife4j
官网 https://doc.xiaominfo.com/knife4j/
Swagger 在微服务架构下 需要每个微服务都需要引入(后端Java + 前端Ui资源),显得有些臃肿
Swagger升级版
- ui更好看了 https://doc.xiaominfo.com/knife4j/documentation/ui.html
- 适配SpringCloud微服务项目,只需要在网关层集成 前端Ui资源
- 在每个微服务的Spring Boot项目下,引入knife4j提供的微服务starter
<dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-micro-spring-boot-starter</artifactId> <version>${knife4j.version}</version> </dependency>
- 在网关聚合文档服务下,可以再把前端的ui资源引入
<dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>${knife4j.version}</version> </dependency>