使用API Blueprint编写接口文档

·  阅读 1473

概述

本文主要是博主自己优选的博客收集,我就是按照这些博客进行安装的,最后使用成功。 主要是为了减少大家查询资料的时间,以及避免一些坑,提高工作效率。

一、准备工作

1. Windows10 安装Node.js

juejin.cn/post/684490… 这篇教程非常详细,推荐使用“淘宝NPM镜像”速度更快。

2. Windows10 安装python

juejin.cn/post/684490… 这篇教程非常详细,有百度网盘的链接,可避免外网下载。 避坑指南: 尽量不要下载最新的版本。

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. 在1处选择命令框
  2. 在2处打命令(具体命令同上)
  3. 可使用相对路径

三、终极避坑

CMD命令请以管理员身份运行!(省不少的心)

分类:
后端
标签:
分类:
后端
标签:
收藏成功!
已添加到「」, 点击更改