MagicAPI学习笔记

magicAPI和自开发java方法(service)的3种交互方式：

1. 引用自开发java方法UserService,  引用magicAPI自封装的body对象

import com.edw.etlapi.service.UserService
return UserService.findUserByName(body.name)

2.引用自开发java方法UserService，引用request对象

import com.edw.etlapi.service.UserService
import request
var name= request.getValues("name")
return UserService.findUserByName(name)

3.引用http包，选择异步调用

import http;
var url = 'http://localhost:9999/login'
return http.connect(url)
        .contentType('application/json')
        .body(body)
        .post()
        .getBody()

4.统一请求响应-自定义状态码，自定义响应JSON格式

#4.1 自定义响应状态码

magic-api目前内置了三种状态码，分别为 执行成功(1)，参数验证失败(0)，以及系统异常(-1)

spring-boot 配置文件 yml

magic-api:
 response-code:
    success: 20000 #执行成功的code值
    invalid: 400 #参数验证未通过的code值
    exception: 500 #执行出现异常的code值

#4.2 自定义响应JSON格式

json原格式：

{
  "code": 1,  // 状态码
  "message": "success", // 状态说明
  "data": ...,  // 返回的数据内容
  "timestamp": 1629610503506, // 服务器时间
  "executeTime": 1  // 执行时间
}

可以通过yml配置文件来修改此格式

magic-api:
  response:   --#配置JSON格式，格式为magic-script中的表达式
    {
      code: code,
      message: message,
      data,
      timestamp,
      requestTime,
      executeTime,
    }