restful api文件生成器 神器

2021-07-14 11:46:27 字數 589 閱讀 9945

我現在還不是很懂到底什麼才是restful api,目前理解的大概就是:一種介面,只管拿引數進來,做一系列處理,返回json字串形式的結果。而restful api風格的api文件,就是用來說明這個介面需要傳進什麼引數,每個引數是什麼含義,有什麼要求,經過處理之後,該介面返回了什麼內容,每乙個資料代表什麼意思。另外該工具還提供許多可直接使用的設定引數,可在頁面生成示例等。

這個是官網,以現在的能力還不能只看官網就搞定。所以借助雷鋒們的部落格 這個雖然是拿的mac做測試,但是基本步驟是差不多的。需要注意的是先要安裝nodejs的環境(雖然我也不曉得是個什麼鬼,大概就是要用那個npm工具去安裝apidoc) 接下來還參考了這個部落格

先拿在官網下的template測一下比較靠譜~

然後可以看看官網那些個例子,所有以@api開頭的引數是什麼意思,如何設定,生成的效果是什麼樣子。

對了,生成doc必須的兩個檔案apidoc.json(或者package.doc)和寫好了注釋的原始檔。

準備好了這兩樣,開cmd,進入放檔案的目錄,打上apidoc回車。有更多高大尚的生成指令,參見官網。

這個神器生成出的效果別提多好了。把bak檔案放在一起就會生成在同乙個doc中。

Golang iris API文件生成器

這裡有各個 框架的 使用方式 go get github.com betacraft yaag 2 引入對應的包 3 初始化 initialize yaag yaag.init yaag.config on true,doctile iris docpath apidoc.html 4 註冊中介軟體...

分析報告生成器,Word文件自動生成器

多特 軟體介紹 該軟體為共享軟體,如果你喜歡這個軟體,並且能為你帶來價值,請購買。軟體 為 2900元 套.乙個使用者可以部署在兩台電腦上執行。在日常工作中,你一定遇到這樣的事情,經常要在每個固定時間出乙個報告,或簡單或複雜。每次還可能要改動一些引數。報告的形式可能是文字描述,也有圖表,但格式都不固...

Linux 文件生成器doxygen

部落格 半閒居士 doxygen是乙個自動文件生成工具,根據 裡寫的注釋,自動生成html和latex格式的文件。通常是給c 用的,通常是輸出html格式的,你看到的pcl網上文件就是拿doxygen生成的。事實上,隨意乙份 都可以拿doxygen生成乙個文件,然後在本地看它的 結構。我們拿以難讀著...