使用API Blueprint編寫接口文檔

概述

本文主要是博主本身優選的博客收集，我就是按照這些博客進行安裝的，最後使用成功。 主要是爲了減小你們查詢資料的時間，以及避免一些坑，提升工做效率。

1、準備工做

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…

2、開始編寫

1. 基本語法

• 有markdown語法基礎的人用起來可能比較快一點
• 網上或者公司有不少事例，複製過來改改看看基本上就會了

2. 生成Html頁面

2.1 普通命令生成

aglio -i 接口文件.apib -o 接口文件.html
複製代碼

• 解釋一下
  • -i 輸入（input）：後面接文件地址+文件名稱（寫全了）
  • -o 輸出（output）：後面接目標文件地址+文件名稱（是Html後綴的）

2.2 IDEA使用Aglio

1. 在1處選擇命令框
2. 在2處打命令（具體命令同上）
3. 可以使用相對路徑

3、終極避坑

CMD命令請以管理員身份運行！（省很多的心）