使用API Blueprint編寫介面檔案
阿新 • • 發佈：2020-06-24
概述
本文主要是博主自己優選的部落格收集，我就是按照這些部落格進行安裝的，最後使用成功。 主要是為了減少大家查詢資料的時間，以及避免一些坑，提高工作效率。
一、準備工作
1. Windows10 安裝Node.js
juejin.im/post/5c4156… 這篇教程非常詳細，推薦使用“淘寶NPM映象”速度更快。
2. Windows10 安裝python
juejin.im/post/5d733f… 這篇教程非常詳細，有百度網盤的連結，可避免外網下載。 避坑指南： 儘量不要下載最新的版本。
3. 安裝Aglio
可參考：blog.csdn.net/tjj3027/art…
方法一：使用原版倉庫
npm install -g aglio
複製程式碼 方法二：使用淘寶映象（推薦）
cnpm install -g aglio
複製程式碼cnpm命令就是安裝Node.js教程裡面的
閉坑指南：
-
報Visual Studio找不到之類的錯誤
- 我是下載了一個Visual Studio 2019，因為後面的開發要用到。這個錯誤很奇怪，你們可以不下載試試（我沒有試過）
-
報phtyon之類的錯誤
- 我的可能是因為phtyon版本過高，雖然報錯了，但是被我忽略掉了，目前可以正常執行
4. 高亮文字編輯工具
- 第一種：Sublime Text + API Blueprint Sublime Text Plugin（推薦）
- 第二種：Atom + API Blueprint Grammar for Atom + API Blueprint Preview（不推薦）
- 參考文章地址：imkcat.com/write-restf…
二、開始編寫
1. 基本語法
- 有markdown語法基礎的人用起來可能比較快一點
- 網上或者公司有很多事例，複製過來改改看看基本上就會了
2. 生成Html頁面
2.1 普通命令生成
aglio -i 介面檔案.apib -o 介面檔案.html
複製程式碼- 解釋一下
- -i 輸入（input）：後面接檔案地址+檔名稱（寫全了）
- -o 輸出（output）：後面接目標檔案地址+檔名稱（是Html字尾的）
2.2 IDEA使用Aglio
- 在1處選擇命令框
- 在2處打命令（具體命令同上）
- 可使用相對路徑
三、終極避坑
CMD命令請以管理員身份執行！（省不少的心）