轻松记录您
灵感和创意

markdown写接口文档语法

后端接口功能开发完成后,接入接口的同事需要知道每个接口的功能,以及请求需要带哪些参数等,所以,提供接口文档给别人查看就显得非常必要了;用Markdown写文档的好处在于文档的排版整齐、格式统一,写起文档更加简单、快速。关于 Markdown 的详细语法,可以参考Markdown 语法说明。

最近在 github 上开源了基于Markdown编写的接口文档项目api-doc,供大家参考使用;下面大概讲解文档的相关内容:

1. 环境部署/安装

文档基于 gitbook 运行的,所以需要配置 gitbook 的运行环境,配置过程如下:

1.1 克隆源代码

> git clone https://github.com/WongMinHo/api-doc.git

1.2. 配置本地运行环境

1). 安装npm

从官网下载源码,解压,执行如下命令安装:

./configure
make
make install

2). 安装gitbook

npm install gitbook-cli -g

如果安装太慢,可以设置淘宝代理镜像,执行命令:

npm config set registry https://registry.npm.taobao.or

查看gitbook是否安装成功:

gitbook -V

使用

进入api-doc目录,执行命令:

gitbook serve

 

未经允许不得转载:坚果云Markdown编辑器 » markdown写接口文档语法
分享到: 更多 (0)

坚果云Markdown轻松记录您 灵感和创意

坚果云Markdown下载坚果云Markdown介绍