接口&接口文档

　

接口文档

一、接口简介

API（APPlication Programming Interface）即应用程序接口，可以任务是一个软件组件或一个Web服务与外界进行交互的接口，在这里接口可以和API划等号。

接口可以简单的理解为一个黑盒子，从一边输入参数，另外一遍输出参数，黑盒子中的逻辑控制输入输出。

在web后端开发中，接口接受前端（browser、app、client）传入的数据，处理之后要么返回给前端想要的数据（json）要么将数据存储到数据库中（mysql、redis）

二、接口文档

接口文档又叫（规范性文档）。接口文档有规范的格式和内容要求，后端按照接口协议接收前端传递的合法数据和返回符合的规范的数据，前端按照接口协议传递符合规范的数据和对后端返回的数据依据展示的需要做处理

三、接口文档编写规范

1、内容

文档包含以下内容：

1. 接口说明
2. 请求方式（GET/POST/RETRIEVE/UPDATE)
3. 调用URL（接口地址）
4. 请求参数，包含参数类型及其限制条件
5. 返回参数说明（返回包结构体）

2、示例

接口说明：注册接口

相关阅读

根据条形码编号查询商品名称免费接口

最近在做的一个功能设计到条形码查询商品的接口，百度一大圈，终于找到了一个靠谱的，链接地址如下 源自阿里云中的一帖子的答复： https:

Java接口的概念

接口的概念   在Java中接口是一个全部由抽象方法组成的集合，接口需要用interface定义，里面只能有抽象的方法和常量。接口体现的是

微信域名防封防屏蔽系统的API接口实现原理

近常常听到搞微商，微信项目的在叫苦，由于微信域名屏蔽，哀鸿遍野。微信官方在对微信中推广活动的第三方网页内容管控越来越严格，如果活

Hibernate之Query接口的uniqueResult()方法

如果查询返回多个值用list()方法public void testQuery(){ Configuration config = new Configuration().configure(); Sessi

PowerManager goToSleep 接口

以power键为例，power键按下灭屏的 reason为PowerManager.GO_TO_SLEEP_REASON_POWER_BUTTON,flag为0. 实际是通过binder服务调用P