# 【 默认接口服务 默认】接口文档 v1.0.0
**所属平台**: PhalApi开源接口框架
**接口地址**: `http://demo.phalapi.net/?s=App.Site.Index`
**请求方式**: POST
## 接口基本信息
- **功能描述**: 默认接口服务,当未指定接口服务时执行此接口服务
- **返回格式**: JSON
## 请求参数说明
### 系统参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| s | string | 必填 | 接口服务名,固定为`App.Site.Index` |
### 业务参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| username | string | 可选 | 用户名 |
## 返回字段
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret | int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.title | string | 标题|
| data.content | string | 内容|
| data.version | string | 版本,格式:X.X.X|
| data.time | int | 当前时间戳|
## 请求示例
```bash
curl -X POST 'http://demo.phalapi.net/?s=App.Site.Index' \
-H 'Content-Type: application/json' \
-d '{"username":"PhalApi"}'
```
返回示例:
```json
{
"ret": 200,
"data": {
"title": "Hello PhalApi",
"version": "2.7.0",
"time": 1558489902
},
"msg": ""
}
```
{
"ret": 200,
"data": {
"title": "Hello PhalApi",
"version": "2.7.0",
"time": 1558489902
},
"msg": ""
}
curl http://demo.phalapi.net/?s=App.Site.Index&username=PhalApi
{"ret":200,"data":{"title":"Hello PhalApi","version":"2.13.1","time":1585536376},"msg":""}
$.ajax({
url: "http://demo.phalapi.net/",
data: {s: "App.Site.Index", username: "PhalApi"},
dataType: 'json',
success: function (response, status, xhr) {
console.log(response);
}
});
<?php
require_once dirname(__FILE__) . '/PhalApiClient.php';
$client = PhalApiClient::create()
->withHost('http://demo.phalapi.net/');$rs = $client->reset()
->withService('App.Site.Index')
->withParams('username', 'PhalApi')
->withTimeout(3000)
->request();
// ret状态码,200表示成功
var_dump($rs->getRet());
// 业务数据
var_dump($rs->getData());
// 提示信息
var_dump($rs->getMsg());
#-*- coding:utf-8 -*-
import PhalApiClient
result = PhalApiClient.PhalApiClient('http://demo.phalapi.net/', 'App.Site.Indexx', {'username': 'PhalApi'}, 3)
//FullscreenActivity.java
import net.phalapi.sdk.*; /**
* 网络操作相关的子线程
*/
Runnable networkTask = new Runnable() {
@Override
public void run() {
// TODO
// 在这里进行 http request.网络请求相关操作
PhalApiClient client = PhalApiClient.create()
.withHost("http://demo.phalapi.net/");
PhalApiClientResponse response = client
.withService("App.Site.Index")
.withParams("username", "dogstar")
.withTimeout(3000)
.request();
String content = "";
content += "ret=" + response.getRet() + "\n";
if (response.getRet() == 200) {
try {
JSONObject data = new JSONObject(response.getData());
content += "data.title=" + data.getString("title") + "\n";
content += "data.content=" + data.getString("content") + "\n";
content += "data.version=" + data.getString("version") + "\n";
} catch (JSONException ex) {
}
}
content += "msg=" + response.getMsg() + "\n";
Log.v("[PhalApiClientResponse]", content);
Message msg = new Message();
Bundle data = new Bundle();
data.putString("value", content);
msg.setData(data);
handler.sendMessage(msg);
}
};
PhalApiClientResponse response = PhalApiClient.create()
.withHost("http://demo.phalapi.net/")
.withService("Default.Index")
.withparamsList("name", "dogstar")
.withTimeout(3000)
.request();
Log.v("response ret", response.ret + "");
Log.v("response data", response.data);
Log.v("response msg", response.msg);
package main
import (
"./PhalApiClient"
"fmt"
"net/url"
)
func main() {
rs, err := PhalApiClient.NewRequest().
WithHost(`http://demo.phalapi.net/`).
WithService("App.Site.Index").
WithParams(url.Values{}).
Get()
if err != nil {
fmt.Println(err.Error())
} else {
fmt.Println("code------------------------", rs.Code)
fmt.Println("data------------------------", rs.Data)
fmt.Println("msg------------------------", rs.Msg)
}
}
#import "AFNPhalApiClient.h"// 待POST的参数
NSDictionary *params = @{@"demo_key_1": @"your_key", @"demo_key_2": @"1.0"};
// 使用AFNPhalApiClient
[[[[[AFNPhalApiClient sharedClient] withHost:@"http://demo.phalapi.net/"] withService:@"App.Site.Index"] withParams:params] requestWithFormDataBlock:^(id formData) {
// 如需上传文件(图片等),请参照如下格式
[formData appendPartWithFileData:UIImageJPEGRepresentation([UIImage imageNamed:@"head.JPG"], 1) name:@"file" fileName:@"image.jpg" mimeType:@"image/jpeg"];
} completeBlock:^(id resultObject) {
PALog(@"resultObject: %@", resultObject);
} failureBlock:^(NSError *error) {
PALog(@"error: %@", error);
}];
// 打印url查看
PALog(@"total url: %@", [[AFNPhalApiClient sharedClient] printTotalUrlStr]);