基于SpringMVC的API文檔生成方法及系統(tǒng)

基本信息

申請(qǐng)?zhí)?/td> CN201710800995.3 申請(qǐng)日 -
公開(kāi)（公告）號(hào) CN107515771A 公開(kāi)（公告）日 2017-12-26
申請(qǐng)公布號(hào) CN107515771A 申請(qǐng)公布日 2017-12-26
分類號(hào) G06F9/45 分類 計(jì)算；推算；計(jì)數(shù);
發(fā)明人 王思望 申請(qǐng)（專利權(quán)）人 藍(lán)海天網(wǎng)科技有限公司
代理機(jī)構(gòu) 福州科揚(yáng)專利事務(wù)所 代理人 林朝熙
地址 350001 福建省福州市鼓樓區(qū)烏山西路318號(hào)洪山科技園創(chuàng)業(yè)中心大廈第3層
法律狀態(tài) -

摘要

摘要 基于SpringMVC的API文檔生成方法及系統(tǒng)，通過(guò)自定義的注解，在自定義數(shù)據(jù)Bean中標(biāo)記API信息，所述自定義Bean用于服務(wù)端代碼的Controller層的函數(shù)的出參入?yún)ⅲ闅v服務(wù)端運(yùn)行的代碼Controller層方法，自動(dòng)抓取其函數(shù)的入?yún)⒊鰠⒁茫馕龀鰠⑷雲(yún)⒌乃袇?shù)，生成API文檔，通過(guò)所述參數(shù)對(duì)象的相互引用嵌套，自動(dòng)構(gòu)建起API的參數(shù)層級(jí)結(jié)構(gòu)，然后將其遍歷解析得到的結(jié)果下發(fā)到Web客戶端，為前端開(kāi)發(fā)人員提供可視化的API技術(shù)文檔。本發(fā)明可解決API文檔更新不及時(shí)，維護(hù)成本高等問(wèn)題，節(jié)約開(kāi)發(fā)人員時(shí)間成本，提高工作積極性。