當前位置:
首頁 >
Api文档生成工具与Api文档的传播(pdf)
發布時間:2024/4/17
50
豆豆
生活随笔
收集整理的這篇文章主要介紹了
Api文档生成工具与Api文档的传播(pdf)
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
點擊查看apidoc生成文檔demo
1 環境和工具
win10
- apidoc:注釋生成api文檔
- wkhtmltopdf:apidoc生成的是html,不適合傳播,于是通過wkhtmltopdf將html轉換成pdf文件
- git:命令行工具和代碼版本控制工具(非必要)
- Typora:markdown文件編輯工具(非必要)
文本編輯工具:VSCode(非必要)
2 準備
(1)apidoc的安裝
安裝Nodejs
- 官網地址:http://nodejs.cn/download/
- 根據自己的系統環境下載并安裝
- 檢測是否安裝成功)
通過Nodejs的包管理工具安裝apidoc
- 安裝
- 檢測是否安裝成功
(2)wkhtmltopdf的安裝
- 官網下載地址:https://wkhtmltopdf.org/downloads.html
- 根據環境下載并安裝
- 檢測是否安裝成功
3 DEMO
(1)apidoc目錄結構
- apidoc.json:使用apidoc生成api文檔的配置文件
- apidoc.ps1:powershell腳本文件,用于一鍵生成api文檔并打開
- auth.js:api的編寫
- general.md:api文檔可以包含一個md文件
(2)各個文件的內容
- apidoc.json
- apidoc.ps1
- auth.js(代碼的注釋文件)
- general.md
(3)生成api文檔
- 執行apidoc.ps1腳本
- 或者 apidoc命令
(4)html轉pdf
$ wkhtmltopdf.exe -s A3 doc/index.html api.pdf Loading pages (1/6) Counting pages (2/6) Resolving links (4/6) Loading headers and footers (5/6) Printing pages (6/6) Done # 當前目錄下多了一個api.pdf文件4 安利
- apidoc使用參考:http://www.bjhee.com/apidoc.html
- wkhtmltopdf使用參考:https://www.jianshu.com/p/4d65857ffe5e
轉載于:https://www.cnblogs.com/linzhanfly/p/9685794.html
總結
以上是生活随笔為你收集整理的Api文档生成工具与Api文档的传播(pdf)的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: JVM总结---各处总结
- 下一篇: Xamarin.Forms 中iOS通过