https://github.com/yurunsoft/apiagent

PHP开发的API接口代理，支持跨域接口代理和接口合并请求功能。程序员聚集群：74401592
https://github.com/yurunsoft/apiagent

api composer php

Last synced: 20 days ago
JSON representation

PHP开发的API接口代理，支持跨域接口代理和接口合并请求功能。程序员聚集群：74401592

• Host: GitHub
• URL: https://github.com/yurunsoft/apiagent
• Owner: Yurunsoft
• License: mit
• Created: 2017-06-08T06:28:03.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-04-12T01:22:06.000Z (over 6 years ago)
• Last Synced: 2024-10-05T06:44:40.839Z (about 1 month ago)
• Topics: api, composer, php
• Language: PHP
• Homepage: http://git.oschina.net/yurunsoft/apiagent
• Size: 37.1 KB
• Stars: 37
• Watchers: 7
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ApiAgent

## 简介

API接口代理，支持跨域接口代理和接口合并请求功能。

## [在线文档](http://doc.yurunsoft.com/ApiAgent "在线文档")

## 安装

### 当作类库使用

在您的composer.json中加入配置：

```json

{

    "require": {

        "yurunsoft/api-agent": "1.0.*"

    }

}

```

### 作为项目运行

切换到ApiAgent目录下，执行下列命令：

```

composer install

```

## 跨域接口代理

通过`index.php`文件访问，默认参数为`url`，注意需要`urlencode`编码。

例子：`http://apiagent.toolapi.net/?url=http://www.baidu.com`

> （上面是在线演示地址，随时可能崩掉，正式使用时请改成你自己的！）

该接口原样返回状态码、返回头（包括cookie）、返回内容。

配置文件：`Config/cross.php`

## 接口合并请求

通过`batch.php`文件访问，请求规则是POST提交json格式内容。

配置文件：`Config/batch.php`

jQuery调用样例代码：

~~~js

// 设置跨域传递cookie，如果不需要可以去除

$.ajaxSetup({

	xhrFields: {

		withCredentials: true

	},

});

$.ajax({

	// 在线演示地址，随时可能崩掉，正式使用时请改成你自己的

	url: 'http://apiagent.toolapi.net/batch.php',

	method: 'post',

	data: JSON.stringify({

		/*aip: {

			url: 'ip', // 在apis中预定义的接口，传别名即可

			getData: {ip: '218.4.255.255'},

		},*/

		aip: {

			url: 'http://int.dpool.sina.com.cn/iplookup/iplookup.php?format=json',

			getData: {ip: '218.4.255.255'}, // 这里的IP改变也会改变下面baike的结果哦

		},

		// weather2是错误的结果，会中断

		/*weather2: {

			url: 'http://www.weather.com.cn/data/sk/1010101001.html',

			condition: { // 返回结果.weatherinfo不为null

				value: '{$weather2.weatherinfo}',

				regular: 'is not null',

			},

		},*/

		baike: {

			url: 'http://baike.baidu.com/api/openapi/BaikeLemmaCardApi?scope=103&format=json&appid=379020&bk_length=600',

			// get参数

			getData: {

				bk_key: '{$aip.city}', // api接口中返回的数据.city

			},

			// post参数

			postData: {},

			// GET请求数据类型

			getDataType: 'form',

			// POST请求数据类型

			bodyDataType: 'form',

			// 自定义header，不定义则使用默认

			header: {

				'test': 'aaa',

			},

			// 验证返回结果是否正确，不正确会中断请求并返回

			condition: {

				value: '{$baike.errno}',

				regular: 'is not null',

			},

		},

	}),

	success: function(data)	{

		console.debug(data);

	}

});

~~~

### 接口合并请求返回结构

```js

{

	// 是否成功

    "success": true,

	// 错误信息

    "message": "",

	// 返回正文数据

    "data": {

        "test": ""

    },

	// 返回结果

    "result": {

		// 键名=>返回头数据

        "test": {

			// 状态码

            "status_code": 208,

			// 返回头

            "header": {

                "Server": "squid/3.5.20",

                "Date": "Mon, 09 Oct 2017 07:38:54 GMT",

                "Content-Type": "application/octet-stream",

                "Content-Length": "0",

                "Connection": "keep-alive"

            },

			// 请求耗时

            "time": 0.047

        }

    }

}

```

### 预定义验证规则

| 代码 | 含义 |

| --- | --- |

| is null | null === $value |

| is not null | null !== $value |

| empty array | 0 === count($value[0]) |

| not empty array | count($value[0]) > 0 |

| true | true === $value |

| false | false === $value |

> 除了预定义规则，你还可以编写正则来验证。如：\d+

### dataType数据类型

| 名称 | 含义 |

| --- | --- |

| form | 表单参数格式(如：a=1&b=2)，默认 |

| json | 转为json格式提交 |

> 不传默认为form，其它名称不对传递来的参数做任何处理