关于使用Typora制作接口文档的那些事儿

程序开发过程中，团队协作是常态，有人负责前端，有人负责后端，那么前后端交互时的接口文档，就是一个相当关键的【沟通桥梁】，接口文档最常见（仅限于我这种弱智小白的见识范围）的就是markdown文档（.md文件），接下来记录一下我自己用Typora工具制作markDown接口文档的习惯与技巧

---

一：markDown基础常用快捷键

1.段落标题H1~H6    ctrl+数字1~数字6

注意：这里不知道为什么，输入的数字不能用小键盘，否则没有效果

 2.高亮文字    ==文字==

要先到【偏好设置】里面，开启高亮功能

 3.引用效果   ctrl+shift+q

 

 4.引用效果2   ctrl+shift+`

 5.插入代码段  ctrl+shift+k

 6.插入图片  ctrl+shift+i

  选择本地文件图片

或者直接复制粘贴图片也行

图片上传来一开始会显示路径，不过待会就会自动隐藏起来了，不用太在意

 7.分隔线   ---   或者  ***

markdown语法中，插入分割线的快捷键就是输入三个星号或者三个减号

8.插入表格   ctrl+t

以上，就是我在制作接口文档过程中常用的几个快捷键，markDown语法里还有很多快捷键，远不止这点，不过基本常用的就这几个了

 二：制作接口文档的一般格式

注：我的接口文档格式不一定是最标准的，不过是我看的比较顺眼的~

1.开头介绍(酌情编写)

2.模块划分

根据程序各个模块，来编写接口文档，比如：登录页面的方法接口，就放在一起，购物车页面的接口放在一起，各自放在自己的段落下，不要混着放

 

3.接口文档基础格式

 1）请求路径、请求方法

2）请求参数

 3）响应参数

 4）响应数据

 

---

 到此，基础的接口文档制作就完成了，一份好的接口文档，能有效提升沟通效率，减少开发之间的互喷~