开发者社区> 问答> 正文

前后端分离,如何维护Rest API接口文档 ?

前后端分离,如何维护Rest API接口文档 ?

展开
收起
真的很搞笑 2021-10-24 20:38:50 757 0
2 条回答
写回答
取消 提交回答
  • 可以通过接口管理框架swargge自动生成API文档,或者自研类似的框架

    2021-10-25 22:41:30
    赞同 展开评论 打赏
  • 前后端分离开发日益流行,大部分情况下,我们都是通过 Spring Boot 做前后端分离开发,前后端分离一定会有接口文档,不然会前后端会深深陷入到扯皮中。一个比较笨的方法就是使用 word 或者 md 来维护接口文档,但是效率太低,接口一变,所有人手上的文档都得变。在 Spring Boot 中,这个问题常见的解决方案是 Swagger ,使用 Swagger 我们可以快速生成一个接口文档网站,接口一旦发生变化,文档就会自动更新,所有开发工程师访问这一个在线网站就可以获取到最新的接口文档,非常方便。

    2021-10-24 20:39:11
    赞同 展开评论 打赏
问答排行榜
最热
最新

相关电子书

更多
Spring Boot2.0实战Redis分布式缓存 立即下载
CUDA MATH API 立即下载
API PLAYBOOK 立即下载