一、认识几个基本概念
API:以Windows为例, Windows 预先把一些复杂的操作写在一个函数里面(我理解的类似bat批处理),编译成动态链接库(DLL),随Windows一起发布,程序员只需要简单地调用这些函数就可以完成复杂的工作,让编程变得简单有趣。这些封装好的函数,叫做 API(Application Programming Interface)应用程序编程接口。API 函数以C语言的形式向外暴露,可以通过C语言直接调用。API就好像是一个传输数据的通道,入口需要请求数据,相当于通关密码,而出口需要返回结果。接口的使用方不需要关心接口是如何实现的,只关心能不能拿到接口最后的返回结果。接口的提供方需要定义接口请求参数、响应内容等,还需要关注接口的性能,是否能满足高并发的调用,接口的稳定性如何……总之,API就是一个预先定义的函数。Windows API 函数成千上万,详细了解每一个函数的用法是不可能的,也是完全没有必要的。只需知道哪些功能由哪些API 函数提供就行了,等使用它们时再去查阅帮助文件。
SDK:编程就是直接调用API 函数进行编程。SDK 是 Software Development Kit 的缩写,即软件开发工具包。
GUI:带界面的程序的专业称呼是GUI程序。GUI 是 Graphical User Interface 的简写,即图形用户界面。本教程将教你使用 Windows API 来编写GUI程序,编程语言为C语言。
二、看懂API文档
API文档
API接口一般分为接口描述、接口地址、请求方法、请求参数、相应内容、错误代码、实例几个部分。
1、接口描述
简单描述接口的逻辑和作用
2、接口地址
接口的正式url和接口测试的url,需求方通过调用接口url,获取响应内容
3、请求方法
一般来说,接口最常见的请求方法为GET和POST两种方式,即读接口和写接口。通过这两种方式,实现对数据的增删查改。增删改本质都是写的动作。
4、请求参数
即需要请求的字段名的名称和规则:都是哪些字段,字段的类型是什么,是否必填字段等等
5、响应内容
接口返回的字段名称和规则。
注意:大部分开发往往不会把所有的字段罗列,只会列出比较重要的字段。当你发现,接口文档中没有你需求的字段,别着急找开发,可以看下实例中,有没有需求的字段。
6、错误代码
对接口的错误用代码进行归类,以便能快速找到错误原因,解决问题。
7、实例
实际调用时的响应的内容。
后面将会以实际例子,介绍一下api文档。