Skip to main content

基础

普通页面支持 API 的方式对接外部接口，实现灵活扩展，API 详情请参考 amis 文档。

在AI速搭中有两个特殊功能：

API 代理​

普通页面中的 api 在最终渲染时会进行 url 替换，比如在页面设计中的配置中可能这样写的：

{
  "api": "https://3xsw4ap8wah59.cfc-execute.bj.baidubce.com/api/amis-mock/sample"
}

在实际运行中，AI速搭会将这个地址进行转换，实际在页面中会是类似下面的地址

{
  "api": "/api/proxy/34fbe7"
}

这样做有以下几个好处：

  1. 解决前端跨域问题，因为第三方 api 肯定不在AI速搭域名下
  2. 避免接口地址暴露
  3. 传递一些AI速搭特有的信息，比如当前用户名、环境、应用 key 等

前面说到的特有信息可以通过下面这些 header 获取：

  • x-isuda-token，在「应用设置」中的 token
  • x-isuda-appkey，应用短路径
  • x-isuda-env，应用环境，开发环境是 dev，也可能是 qa、sandbox或者latest
  • x-isuda-userid，用户在AI速搭中的 id，唯一，但是建议用 uid 代替
  • x-isuda-email，用户在AI速搭中的 email
  • x-isuda-uid，用户在AI速搭中的 uid, 唯一标识
  • x-isuda-username，用户名
  • x-isuda-oauth-id，oauth id，如果启用了 oauth 登录的话
  • x-isuda-oauth-access-token，oauth 的 access token 如果启用了 oauth 登录的话
  • x-isuda-roles，用户所属的角色名列表
  • x-isuda-profile-access-token 获取用户信息的 access token，具体请看下方说明

如果不放心直接根据 header 下发的 x-isuda-username 完成用户认证，还可以通过环境变量关掉这个功能

ISUDA_DISABLE_PROXY_USER_ID: true

这样就只会下发以下 header 了。

  • x-isuda-token
  • x-isuda-appkey
  • x-isuda-env
  • x-isuda-profile-access-token
  • x-isuda-oauth-id，oauth id，如果开启了 oauth 登录认证的话
  • x-isuda-oauth-access-token，oauth 的 access token，如果开启了 oauth 登录认证的话

然后通过请求 /openapi/profile?token={{这里用 x-isuda-profile-access-token 返回的 token 值}} 就会获取以下信息。

{
  "username": "xxxx",
  "roles": ["xxxx", "xxx"],
  "userid": "xxxx",
  "email": "xxx@xx.com",
  "uid": "xxxx"
}

如果不想经过内置代理​

可以在 url 前加上 raw:，就不会走代理。

需要解决跨域问题，比如返回跨域 header：示例如下

  • Access-Control-Allow-Origin: https://suda.bce.baidu.com，或者AI速搭部署的域名
  • Access-Control-Allow-Credentials: true
  • Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
  • Access-Control-Allow-Methods: POST, GET, OPTIONS

示例代码（express）：

// 放在所有路由前面
app.use(function (req, res, next) {
  res.header('Access-Control-Allow-Origin', 'https://suda.bce.baidu.com');
  res.header('Access-Control-Allow-Credentials', 'true');
  res.header(
    'Access-Control-Allow-Headers',
    'Origin, X-Requested-With, Content-Type, Accept'
  );
  res.header('Access-Control-Allow-Methods', 'POST, GET, OPTIONS');
  next();
});

如果接口需要登录，可以在未登录的时候返回 401，内容是：

{
  "location": "http://跳转登录的页面地址"
}

需要注意在新浏览器下默认会限制 cookie 跨域，所以登录后保存状态的 cookie 必须加上 SameSite=None; Secure，类似如下

Set-Cookie: session=123; SameSite=None; Secure

如果想本地开发接口请查看这里。

在各种语言下获取参数的方法​

Node​

以 Express 为例

const express = require('express');
const app = express();
const bodyParser = require('body-parser');
app.use(bodyParser.json());
app.post('/api', function(req, res) {
    console.log(req.body);  // 参数 json
    res.json(...);
})
app.listen(3000)

Java​

以 Spring 为例

@RequestMapping(value = "/api", method = POST, consumes = MediaType.ALL_VALUE, produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
@ResponseBody
public String api(@RequestBody String body) {
    // body 就是字符串形式的 json，需要使用 Jackson 等库解析为对象来使用
}

PHP​

<?PHP
$json = file_get_contents('php://input');
$data = json_decode($json);

.NET​

using Microsoft.AspNetCore.Mvc;
using System.IO;
using Newtonsoft.Json;

namespace MvcMovie.Controllers
{
    public class HelloWorldController : Controller
    {
        [HttpPost]
        public JsonResult Index()
        {

            using (var reader = new StreamReader(HttpContext.Request.Body))
            {
                dynamic json = JsonConvert.DeserializeObject(reader.ReadToEnd());
                var conditions = json.conditions;
                var data = new { status = 0, msg = "" };
                return Json(data);
            }
        }
    }
}

go​

func api(w http.ResponseWriter, r *http.Request) {
    body, _ := ioutil.ReadAll(r.Body)
    var result map[string]interface{}  // 这里简化了，最好参考对应的参数说明文档创建 struct
    json.Unmarshal(body, &result)
}

Python​

import json
# falcon 框架
class SugarAPI(object):
    def on_post(self, req, resp):
        data = json.load(req.bounded_stream)

# flask 框架
from flask import request
@app.route('/api', methods=['POST'])
def sugar_api():
    data = json.loads(request.data)

Ruby​

require 'sinatra'
require 'json'

post '/api/' do
  request.body.rewind
  request_payload = JSON.parse request.body.read
end