API接口一般分为接口描述、接口地址、请求方法、请求参数、相应内容、错误代码、实例几个部分。
1、接口描述
简单描述接口的逻辑和作用
2、接口地址
接口的正式url和接口测试的url，需求方通过调用接口url，获取响应内容
3、请求方法
一般来说，接口最常见的请求方法为GET和POST两种方式，即读接口和写接口。通过这两种方式，实现对数据的增删查改。增删改本质都是写的动作。
4、请求参数
即需要请求的字段名的名称和规则：都是哪些字段，字段的类型是什么，是否必填字段等等
5、响应内容
接口返回的字段名称和规则。
注意：大部分开发往往不会把所有的字段罗列，只会列出比较重要的字段。当你发现，接口文档中没有你需求的字段，别着急找开发，可以看下实例中，有没有需求的字段。
6、错误代码
对接口的错误用代码进行归类，以便能快速找到错误原因，解决问题。
7、实例
实际调用时的响应的内容。
做产品经理是难的，因为要懂得的东西太多了，而做产品经理也是容易的，因为有些东西根本不需要精通，只要略懂就可以了，基本上你能把以上几个部分搞明白，看懂一个API文档是没有问题的，和技术人员对接的时候也不会再被吐槽是个傻逼。总之，产品经理做得好就风风光光，做不好会人人喊打，根本就是条不归路，而我已经在这条路上越走越远……
网友评论