API接口是什么?怎么去看懂API接口文档?

很多产品经理刚接触 API 接口工作时,脑子一片空白,不理解接口(API)是什么,更看不懂接口开发文档。那么,作为一个不懂技术的产品经理,该如何看懂接口文档。今天这篇文章就跟大家好好巴拉巴拉。

什么是API接口

在项目开发汇总,web项目的前后端是分离开发的。应用程序的开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。

为什么有API接口文档

1)项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发

2)项目维护中或者项目人员更迭的时候,方便后期人员查看、维护

怎么看懂API文档

API 接口文档一般分为接口描述、接口地址、请求方法、请求参数、相应内容、错误代码、实例几个部分。

1、接口描述:简单描述接口的逻辑和作用

2、接口地址:接口的正式 url 和接口测试的 url,需求方通过调用接口 url,获取响应内容

3、请求方法:一般来说,接口最常见的请求方法为 GET 和 POST 两种方式,即读接口和写接口。通过这两种方式,实现对数据的增删查改。增删改本质都是写的动作。

4、请求参数:即需要请求的字段名的名称和规则:都是哪些字段,字段的类型是什么,是否必填字段等等

5、响应内容:接口返回的字段名称和规则。注意:大部分开发往往不会把所有的字段罗列,只会列出比较重要的字段。当你发现,接口文档中没有你需求的字段,别着急找开发,可以看下实例中,有没有需求的字段。

6、错误代码:对接口的错误用代码进行归类,以便能快速找到错误原因,解决问题。

7、实例实际:调用时的响应的内容。

总结

总的来说,对于产品经理熟悉官方API文档,是非常有必要的一件事情。无论是从产品设计的角度,还是对于和开发的沟通协调,以及产品经理自身修养的提高等,都会有不少的帮助,可以让你从更高的纬度去俯视整个产品。


最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容