API管理工具Swagger介绍及Springfox原理分析
swagger是一个API框架,号称世界上最流行的API工具。它提供了API管理的全套解决方案,比如API在线编辑器,API UI展示界面,代码生成器等诸多功能。
如果想引入swagger进行API管理。目前 springfox 是一个很好的选择,它内部会自动解析Spring容器中Controller暴露出的接口,并且也提供了一个界面用于展示或调用这些API。下图就是简单的一个使用springfox的API展示界面。
springfox的前身是swagger-springmvc,用于springmvc与swagger的整合。
如若在springboot项目中使用springfox,需要3个步骤:
- maven添加springfox依赖
- 启动类加上@EnableSwagger2注解
- 构造Docket bean用于展示API
配置完之后进入 http
