单页前后端分离开发模式怎么使用swagger改善开发流程

Question

现将项目后端渲染的方式改为前端渲染的方式，进行前后端分离，未了便于前后端开发人员的沟通，决定使用swagger来定义API文档，没有具体的使用经验，是先写好swagger文档，提供给前端还是通过代码注解的方式生成swagger，node.js做服务端开发语言，有没注解生成swagger文档的工具，具体流程该怎么使用

Answer 1

首先：swagger并不一定能够改善开发流程，我们公司后端的接口文档就是用swagger呈现的文档，然而大多数文档年久失修，也不更新。

从本质上说，你需要的并不一定是swagger文档。而是一套接口定义规范，有了规范，大家就去遵守。即使是普通的markdown文档，也能很好的沟通，没必要一定swagger。而且我觉得部署swagger比较麻烦，改个字段都很费劲。

另外swagger并不是从注释中自动生成的，是需要在swagger编辑器中手动去定义字段属性的，所以可能会很繁琐。

或许你也可以试试接口文档管理工具-DOClever部署实践, 开源免费接口管理平台eoLinker AMS

Answer 2

如果你是前端开发者，你需要什么信息？
如果你是接口开发者，你能给前端什么信息来与接口对接信息？
看下demo?
http://www.sosoapi.com/

个人认为是前者好点

Answer 3

去百度上查下资料，demo很多的