共计 683 个字符，预计需要花费 2 分钟才能阅读完成。
什么是接口
接口全称是应用程序编程接口，是应用程序重要的组成部分。接口能够是一个性能，例如天气查问，短信群发等，接口也能够是一个模块，例如登录验证。接口通过发送申请参数至接口 url，通过后盾代码解决后，返回所需的后果。
为什么须要编写接口文档
因为接口所蕴含的内容比拟细，在我的项目中经常须要应用接口文档。研发人员能够依据接口文档进行开发、合作，测试人员能够依据接口文档进行测试，零碎也须要参照接口文档进行保护等。
接口文档标准
接口文档内容可大抵分为申请前、申请后内容。
申请前的内容包含接口的根本信息。内容如下：
1、接口协议。如 http、https、tcp 协定等。
2、接口申请形式。常见的申请形式有 get、post，还有 put、delete 等。
3、接口 url。接口申请的 url
4、接口名称。用于辨认接口。
5、接口申请头部。蕴含申请头部参数、参数阐明。
6、接口申请体。蕴含申请参数、参数阐明，与参数格局。
7、
申请后的内容包含接口响应后的后果。内容如下：
1、响应后果。包含返回头部、返回后果参数，参数值阐明，参数类型。
2、示例。胜利示例与失败示例，与对应的状态码，例如胜利返回状态码 200。
3、
以上是接口文档必要的根本信息，在我的项目中为了不便问题追溯与前期保护，接口文档还须要记录接口状态、版本、负责人、创建人、最初编辑人、工夫、接口阐明等信息。最终一份欠缺的 api 文档如下所示。
接口文档编写须要破费肯定的精力，随着我的项目不断更新，接口文档也逐步成为我的项目的外围文件。写好接口文档是应用程序倒退的根底。
演示工具为 Eolinker，应用地址：www.eolinker.com