現(xiàn)將項(xiàng)目后端渲染的方式改為前端渲染的方式,進(jìn)行前后端分離,未了便于前后端開發(fā)人員的溝通,決定使用swagger來定義API文檔,沒有具體的使用經(jīng)驗(yàn),是先寫好swagger文檔,提供給前端還是通過代碼注解的方式生成swagger,node.js做服務(wù)端開發(fā)語言,有沒注解生成swagger文檔的工具,具體流程該怎么使用
如果你是前端開發(fā)者,你需要什么信息?
如果你是接口開發(fā)者,你能給前端什么信息來與接口對(duì)接信息?
看下demo?
http://www.sosoapi.com/
個(gè)人認(rèn)為是前者好點(diǎn)
首先:swagger并不一定能夠改善開發(fā)流程,我們公司后端的接口文檔就是用swagger呈現(xiàn)的文檔,然而大多數(shù)文檔年久失修,也不更新。
從本質(zhì)上說,你需要的并不一定是swagger文檔。而是一套接口定義規(guī)范,有了規(guī)范,大家就去遵守。即使是普通的markdown文檔,也能很好的溝通,沒必要一定swagger。而且我覺得部署swagger比較麻煩,改個(gè)字段都很費(fèi)勁。
另外swagger并不是從注釋中自動(dòng)生成的,是需要在swagger編輯器中手動(dòng)去定義字段屬性的,所以可能會(huì)很繁瑣。
或許你也可以試試接口文檔管理工具-DOClever部署實(shí)踐, 開源免費(fèi)接口管理平臺(tái)eoLinker AMS
北大青鳥APTECH成立于1999年。依托北京大學(xué)優(yōu)質(zhì)雄厚的教育資源和背景,秉承“教育改變生活”的發(fā)展理念,致力于培養(yǎng)中國IT技能型緊缺人才,是大數(shù)據(jù)專業(yè)的國家
北大青鳥中博軟件學(xué)院創(chuàng)立于2003年,作為華東區(qū)著名互聯(lián)網(wǎng)學(xué)院和江蘇省首批服務(wù)外包人才培訓(xùn)基地,中博成功培育了近30000名軟件工程師走向高薪崗位,合作企業(yè)超4
中公教育集團(tuán)創(chuàng)建于1999年,經(jīng)過二十年潛心發(fā)展,已由一家北大畢業(yè)生自主創(chuàng)業(yè)的信息技術(shù)與教育服務(wù)機(jī)構(gòu),發(fā)展為教育服務(wù)業(yè)的綜合性企業(yè)集團(tuán),成為集合面授教學(xué)培訓(xùn)、網(wǎng)
達(dá)內(nèi)教育集團(tuán)成立于2002年,是一家由留學(xué)海歸創(chuàng)辦的高端職業(yè)教育培訓(xùn)機(jī)構(gòu),是中國一站式人才培養(yǎng)平臺(tái)、一站式人才輸送平臺(tái)。2014年4月3日在美國成功上市,融資1
曾工作于聯(lián)想擔(dān)任系統(tǒng)開發(fā)工程師,曾在博彥科技股份有限公司擔(dān)任項(xiàng)目經(jīng)理從事移動(dòng)互聯(lián)網(wǎng)管理及研發(fā)工作,曾創(chuàng)辦藍(lán)懿科技有限責(zé)任公司從事總經(jīng)理職務(wù)負(fù)責(zé)iOS教學(xué)及管理工作。
浪潮集團(tuán)項(xiàng)目經(jīng)理。精通Java與.NET 技術(shù), 熟練的跨平臺(tái)面向?qū)ο箝_發(fā)經(jīng)驗(yàn),技術(shù)功底深厚。 授課風(fēng)格 授課風(fēng)格清新自然、條理清晰、主次分明、重點(diǎn)難點(diǎn)突出、引人入勝。
精通HTML5和CSS3;Javascript及主流js庫,具有快速界面開發(fā)的能力,對(duì)瀏覽器兼容性、前端性能優(yōu)化等有深入理解。精通網(wǎng)頁制作和網(wǎng)頁游戲開發(fā)。
具有10 年的Java 企業(yè)應(yīng)用開發(fā)經(jīng)驗(yàn)。曾經(jīng)歷任德國Software AG 技術(shù)顧問,美國Dachieve 系統(tǒng)架構(gòu)師,美國AngelEngineers Inc. 系統(tǒng)架構(gòu)師。