From ac8603bc290dd503553536167288a2061b7e3cfb Mon Sep 17 00:00:00 2001
From: jiangyanjun <278251091@qq.com>
Date: Wed, 18 Jan 2023 10:12:58 +0800
Subject: [PATCH] first commit

---
 .gitignore      |  5 ++++
 接口规范.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 75 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 接口规范.md

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..d89ae77
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,5 @@
+# misc
+.DS_Store
+.vscode/
+.idea/
+*.swp
\ No newline at end of file
diff --git a/接口规范.md b/接口规范.md
new file mode 100644
index 0000000..3a8eac8
--- /dev/null
+++ b/接口规范.md
@@ -0,0 +1,70 @@
+#### 通用请求
+
+```json
+{
+  "key_xx": "value_xx「任意类型值」",
+  "key_yy": "value_yy「任意类型值」"
+}
+```
+
+#### 通用正确返回
+
+```json
+{
+  "code": 200,
+  "data": "result_「任意类型值」",
+  "message": "success"
+}
+```
+
+#### 通用错误返回
+
+```json
+{
+  // 错误码，跟 http-status 一致，并且在 grpc 中可以转换成 grpc-status
+  "code": 500,
+  // 错误原因，定义为业务判定错误码
+  "reason": "USER_NOT_FOUND",
+  // 错误信息，为用户可读的信息，可作为用户提示内容
+  "message": "invalid argument error"
+}
+```
+
+#### 列表请求
+
+```json
+{
+  "page": 1,
+  "per_page": 10,
+  "key_xx": "value_xx「任意类型值」"
+}
+```
+
+#### 列表返回
+
+```json
+{
+  "code": 200,
+  "data": {
+    "page": 1,
+    "per_page": 10,
+    "total": 1000,
+    "list": ["xxx「任意类型值」"]
+  },
+  "message": "success"
+}
+```
+
+------
+
+#### 高级检索value格式
+
+```json
+[
+  {
+    "operator":"AND",
+    "field":"name",
+    "value":["value_xxx"]
+  }
+]
+```
\ No newline at end of file