概述
通常我们要构建API 服务,自然少不了文档,但由于API与文档的分离使得我们每次对
API进行的更改都需要再去修改文档后同步文档,不但编写稳定繁琐而且稍有纰漏难免
就会出现调用的异常,而编写、同步文档通常是比较繁琐无趣的事。现在得益于spring
Boot 与Swagger,我们不但可以极速的搭建REST、RESTful风格的API服务并且还可以生成优美、强大的在线或离线API文档
API文档自动生成工具有很多种
比如:
Swagger
Spring REST Docs
RAML
ApiDocJS
SpringRestDoc
Swagger是属于比较推荐的一种。
Swagger的特点:
1、在Spring Boot中配置非常简单 ???
2、项目部署时,根据代码自动生成文档,通过html展示
3、代码改动后,项目重新部署时文档会自动更新,无需手动更新文档 ???尝试
4、保证了代码和文档的一致性,不会出现不一致的情况
5、可以直接在文档界面上测试接口,无需再利用第三方来调试接口了