一、多端协议

协议内容格式

请求头

头信息 headerMap

"sec-fetch-mode" -> "cors"
"content-length" -> "482"
"sec-fetch-site" -> "none"
"accept-language" -> "zh-CN,zh;q=0.9"
"cookie" -> "pamirs_uc_session_id=241af6a1dbba41a4b35afc96ddf15915"
"origin" -> "chrome-extension://flnheeellpciglgpaodhkhmapeljopja"
"accept" -> "application/json"
"host" -> "127.0.0.1:8090"
"connection" -> "keep-alive"
"content-type" -> "application/json"
"accept-encoding" -> "gzip, deflate, br"
"user-agent" -> "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.192 Safari/537.36"
"sec-fetch-dest" -> "empty"

请求地址 requestUrl

例如 http://127.0.0.1:8090/pamirs/DemoCore?scene=redirectListPage

HTTP参数键值对 parameterMap

url中queryString在服务端最终会转化为参数键值对。

请求体格式

请求体格式采用GraphQL协议。请求体格式分为API请求和上下文变量。以商品的test接口为例，请求格式如下。

API请求格式

 query{
  petShopProxyQuery {
    queryPage(page: {currentPage: 1, size: 1}, queryWrapper: {rsql: "(1==1)"}) {
      content {
        income
        id
        code
        creater {
          id
          nickname
        }
        relatedShopName
        shopName
        petTalents {
          id
          name
        }
        items {
          id
          itemName
        }
      }
      size
      totalPages
      totalElements
    }
  }
}

上下文变量 variables

请求策略requestStrategy

上下文变量式例如下。

{
 "requestStrategy": {
 "checkStrategy": "RETURN_WHEN_COMPLETED",
 "msgLevel":"INFO"
 }
}

响应体格式

协议响应内容包括data、extensions和errors三部分，extensions和errors是可缺省的。data部分为业务数据返回值。应用业务层可以在extensions中添加API返回值之外的扩展信息。extensions中包含success、messages和extra三部分，success标识请求是否成功。如果业务正确处理并返回，则errors部分为空；如果业务处理返回失败，则将错误信息添加到errors中。

正确响应格式示例如下。

{
  "data": {
    "petShopProxyQuery": {
      "queryPage": {
        "content": [
          {
            "id": "246675081504233477",
            "creater": {
              "id": "10001"
            },
            "relatedShopName": "oinone宠物店铺001",
            "shopName": "oinone宠物店铺001",
            "petTalents": [
              {
                "id": "248149320438706183",
                "name": "老邓头"
              }
            ],
            "items": [
              {
                "id": "246675081504233480",
                "itemName": "萌猫商品001"
              },
            ]
          }
        ],
        "size": "1",
        "totalPages": 2,
        "totalElements": "2"
      }
    }
  },
  "errors": [],
  "extensions": {
    "success": true,
    "dataloader": {
      "overall-statistics": {
        "loadCount": 0,
        "loadErrorCount": 0,
        "loadErrorRatio": 0.0,
        "batchInvokeCount": 0,
        "batchLoadCount": 0,
        "batchLoadRatio": 0.0,
        "batchLoadExceptionCount": 0,
        "batchLoadExceptionRatio": 0.0,
        "cacheHitCount": 0,
        "cacheHitRatio": 0.0
      },
      "individual-statistics": {
        "commonDataLoader": {
          "loadCount": 0,
          "loadErrorCount": 0,
          "loadErrorRatio": 0.0,
          "batchInvokeCount": 0,
          "batchLoadCount": 0,
          "batchLoadRatio": 0.0,
          "batchLoadExceptionCount": 0,
          "batchLoadExceptionRatio": 0.0,
          "cacheHitCount": 0,
          "cacheHitRatio": 0.0
        }
      }
    }
  }
}

错误响应格式示例如下。

{
  "data": { "itemMutation": {}},
  "errors": [{
      "message": "校验失败，数据错误",
      "extensions": {
        "errorCode": "10050009",
        "errorType": "SYSTEM_ERROR",
        "level": "ERROR",
        "messages": [{
            "code": "10080016",
            "errorType": "DATA_ERROR",
            "level": "ERROR",
            "message": "长度必须大于或等于4",
            "path": [
              "itemMutation",
              "test",
              "item",
              "description"]},
          {
            "code": "10080016",
            "errorType": "DATA_ERROR",
            "level": "ERROR",
            "message": "字段值必须大于或等于2",
            "path": [
              "itemMutation",
              "test",
              "item",
              "view"]
          }, {
            "errorType": "BIZ_ERROR",
            "level": "ERROR",
            "message": "输入错误，请输入正确的重量",
            "path": [
              "itemMutation",
              "test"]
          },{
            "data": "IS_NULL(activeValue[0].price)",
            "errorType": "BIZ_ERROR",
            "level": "ERROR",
            "message": "输入错误，必填字段",
            "path": [
              "itemMutation",
              "test"]
          }],
        "classification": "DataFetchingException"
      }
  }],
  "extensions": {
    "success": false,
    "extra": { "variableA": "" }
  }
}

二、Pamirs API DSL

Pamirs API DSL采用GraphQL协议。

GraphQL 是一个用于 API 的查询语言，是一个使用基于类型系统来执行查询的服务端运行时（类型系统由你的数据定义）。GraphQL 并没有和任何特定数据库或者存储引擎绑定，而是依靠你现有的代码和数据支撑。

Pamirs aPaaS在GraphQL的基础上支持了BigDecimal、BigInteger、Date、Double、Html、Money、Void、Map、Obj。

三、Pamirs Query DSL

Pamirs Query DSL采用RSQL协议。

协议原文：RSQL is a query language for parametrized filtering of entries in RESTful APIs. It’s based on FIQL (Feed Item Query Language) – an URI-friendly syntax for expressing filters across the entries in an Atom Feed. FIQL is great for use in URI; there are no unsafe characters, so URL encoding is not required. On the other side, FIQL’s syntax is not very intuitive and URL encoding isn’t always that big deal, so RSQL also provides a friendlier syntax for logical operators and some of the comparison operators.

中译说明：RSQL是一种查询语言，用于对RESTful API中的条目进行参数化过滤。它基于FIQL（Feed Item Query Language）——一种URI友好的语法，用于跨Atom Feed中的条目表达过滤器。FIQL非常适合在URI中使用；没有不安全的字符，因此不需要URL编码。另一方面，FIQL的语法不太直观，URL编码也不总是那么重要，因此RSQL还为逻辑运算符和一些比较运算符提供了更友好的语法。