接口文档编写示例

API接口文档的编写已不是什么新鲜事，但文档的编写有时还需针对看文档的人，有所侧重。大多数时候我编写API文档都是针对前台开发、或是后台开发，简单明了就好。比如这两种：
1、wiz笔记中示例

image.png

2、showdoc中的示例

image.png

记得有次公司商务说让我给写几个接口的文档，他给我几点要求：

1. 有几个接口，分别是什么？（例如XX信息下发接口、XX信息更新接口、XX信息反馈接口）
2. 每个接口的作用是什么，传递了哪些信息？（例如XX信息反馈接口传递的具体信息内容主要包括：信息 ID 号、信息接收时间、信息展示时间、信息发布情况…….。）

3. 参考以下格式，每个接口按此编写

   
   
   

   image.png
   
   

   照葫芦画瓢，我编写的如下

   
   
   

   image.png

对比上面两种不同的类型，一个关注技术参数，一个关注业务示意。看来很多时候文档还是需要根据受众而变。