Markdown 接口文档示例

9,900 阅读1分钟

日常开发中的接口文档参考示例,希望能够对小伙伴有点帮助,也希望得到更好的建议

需求

对于后端开发的同学来说,接口文档几乎是必写的,一份好的接口文档不仅不让自己写起来赏心悦目,同时也让接入接口的同事心情愉悦。

在上家公司是用 word 写文档的,那时候会有很多问题,比如字符编码,文本格式等会出现一些问题。并且除非你是非常善于排版的,否则写出来的文档会显得很乱,参差不齐,让人心情都不好了。

后来进入新公司自己独立负责后端的开发后,就开始用 Markdown 来写文档了。发现对于我这么不善于排版的人来说,写文档也是件很简单的事。

用法及工具

Markdown 语法请参照 Markdown 语法说明

Markdown 软件

还有一些可在线编辑 Markdown 的网站:

因为平时工作生活中用的都是 mac,所以 windows 下的工具软件并不清楚,抱歉了。

下面我给出日常文档的一个范例,大家可以参考并提出意见或建议。

示例

以下展示的是图片,感谢公司的 睡病月野兔 ,带病帮我P图,谢谢。

参考示例

为了方便不熟悉 Markdown 的朋友,我已将该文档上传到服务器,有需要可以 点击下载