鍍金池/ 問答/網(wǎng)絡(luò)安全  HTML/ 單頁前后端分離開發(fā)模式怎么使用swagger改善開發(fā)流程

單頁前后端分離開發(fā)模式怎么使用swagger改善開發(fā)流程

現(xiàn)將項目后端渲染的方式改為前端渲染的方式,進行前后端分離,未了便于前后端開發(fā)人員的溝通,決定使用swagger來定義API文檔,沒有具體的使用經(jīng)驗,是先寫好swagger文檔,提供給前端還是通過代碼注解的方式生成swagger,node.js做服務(wù)端開發(fā)語言,有沒注解生成swagger文檔的工具,具體流程該怎么使用

回答
編輯回答
夕顏

去百度上查下資料,demo很多的

2017年1月26日 02:56
編輯回答
笨尐豬

如果你是前端開發(fā)者,你需要什么信息?
如果你是接口開發(fā)者,你能給前端什么信息來與接口對接信息?
看下demo?
http://www.sosoapi.com/

個人認為是前者好點

2018年5月5日 13:25
編輯回答
荒城

首先:swagger并不一定能夠改善開發(fā)流程,我們公司后端的接口文檔就是用swagger呈現(xiàn)的文檔,然而大多數(shù)文檔年久失修,也不更新。

從本質(zhì)上說,你需要的并不一定是swagger文檔。而是一套接口定義規(guī)范,有了規(guī)范,大家就去遵守。即使是普通的markdown文檔,也能很好的溝通,沒必要一定swagger。而且我覺得部署swagger比較麻煩,改個字段都很費勁。

另外swagger并不是從注釋中自動生成的,是需要在swagger編輯器中手動去定義字段屬性的,所以可能會很繁瑣。

或許你也可以試試接口文檔管理工具-DOClever部署實踐, 開源免費接口管理平臺eoLinker AMS

2017年2月12日 19:48