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

前言

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

Typora是一款轻量级的Markdown编辑器，它支持所见即所得（WYSIWYG）的功能，并且具有多种优秀的特性。

首先，Typora的特点包括：

• 快速启动：Typora以其快速的启动时间而著称，这对于需要迅速记录信息的用户来说非常有利。
• 所见即所得：在编辑Markdown文本时，用户可以实时看到最终的输出效果，这极大地简化了格式化文档的过程。
• 丰富的功能支持：Typora支持表格、代码块和数学公式的插入，这使得它非常适合技术写作和学术写作。
• 定制化主题：用户可以根据自己的喜好选择或定制编辑器的主题，以提高写作的舒适度和个性化体验。
• 导出选项：Typora允许用户将文档导出为PDF格式，并且支持生成目录和图片拖拽等功能，方便用户进行文档分享和打印。

其次，Typora的使用场景包括：

• 个人笔记：用于记录日常笔记、学习笔记等，便于管理和查阅。
• 技术文档编写：适合软件开发者编写README文件、API文档等。
• 学术论文撰写：支持的数学公式功能适合科研人员编写包含复杂公式的研究论文。
• 博客文章创作：可以用作博客作者的写作工具，利用Markdown语法快速排版和发布文章。

通过查看Typora的官方文档或相关教程来快速上手，了解其书写功能、主题样式、文件导出等基本操作。对于更高级的用户，掌握Typora的快捷键和高级技巧可以进一步提高编辑效率。

---

一：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）响应数据

 

---

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

---

 博主 [DTcode7] 带您 溺亖在知识的海洋里，嘿嘿嘿.~
🐒 个人主页—— DTcode7 的博客🐒

《微信小程序相关博客》
《Vue相关博客》
《前端开发习惯与小技巧相关博客》
《AIGC相关博客》

《photoshop相关博客》
😚 吾辈才疏学浅，摹写之作，恐有瑕疵。望诸君海涵赐教。望轻喷，嘤嘤嘤 🙈
🕍 愿斯文对汝有所裨益，纵其简陋未及渊博，亦足以略尽绵薄之力。倘若尚存阙漏，敬请不吝斧正，俾便精进！