程序开发过程中，团队协作是常态，有人负责前端，有人负责后端，那么前后端交互时的接口文档，就是一个相当关键的【沟通桥梁】，接口文档最常见（仅限于我这种弱智小白的见识范围）的就是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）响应数据

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

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

在.Net Core中使用Swagger制作接口文档
在实际开发过程中后台开发人员与前端(移动端)接口的交流会很频繁.所以需要一个简单的接口文档让双方可以快速定位到问题所在. Swagger可以当接口调试工具也可以作为简单的接口文档使用. 在传统的asp ...
java如何写安卓接口文档_android、java制作sdk以及自动生成文档
最近一直在做android开发,昨天经理让我写个接口SDK做个接口文档,以便后面的开发. 这让我很焦灼,SDK怎么做?要是只有敲代码还好.可是那个接口文档!!!文档这东西最讨厌了,头都大了后来查了下 ...
正则+Python制作一个轻量级接口文档工具
ApiFormatMd 轻量级Java接口文档生成工具特点完全基于本地代码执行 Java代码无需引用额外依赖生成MarkDown格式文档可使用ShowDoc生成在线文档配置项 main.py ...
CoderHub接口文档
CoderHub接口文档 Coderhub旨在创建一个程序员分享生活动态的平台. 完成的功能如下: 用户管理系统内容管理系统内容评论管理内容标签管理文件管理系统接口完整请求示例:http:/ ...
接口文档编辑工具+接口文档编写
目录接口文档编辑工具接口文档编写补充 GET与POST的区别接口文档编辑工具参考@Lucky锦[接口文档编辑工具] Swagger: 通过固定格式的注释生成文档. 省时省力,不过有点学习成本 ...
基于文档注释接口文档生成工具(代码0侵入附源码)
本文主要分享一个基于个人兴趣,旨在提高工作效率,开发了一个基于文档注释,接口文档生成工具,欢迎大佬指点. 源码以及使用demo地址 :传送门 1.前置介绍 1.1前世现在大多数项目都走向了前后端分离 ...
8、Java如何制作帮助文档
1:如何制作帮助文档 (1)写一个类 (2)加入文档注释 (3)通过javadoc工具生成即可 javadoc -d 目录 -author -version A ...
人人通服务器返回为空,神州付直连接口文档新31全面值返回.pdf
神州付支付平台支付产品支付直连接口文档更新日期:2009-3 版本号:3.1 目录目录1 1 文档说明2 1.1 版本履历2 1.2 谁该读此文档2 1.3 名词缩写及定义2 2 产品简介3 3 ...
引入swagger2 api接口文档并实现离线文档
文章目录前言目的导入工具写一个config类启动类添加注解试启动页面补充并实现文档特殊点再次启动页面导出swagger在线文档为离线文档忽略SSL证书前言本篇文章在于介绍sw ...

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