浏览代码

[Commit] 增加提交接口接口定义

WuXinyu 6 年之前
父节点
当前提交
e14f0260fc
共有 2 个文件被更改,包括 58 次插入0 次删除
  1. 22 0
      api/Commit-提交.md
  2. 36 0
      serializer/CommitSerializer.md

+ 22 - 0
api/Commit-提交.md

@@ -0,0 +1,22 @@
+# Statistic - 系统分析
+
+> url 前缀:**commit**
+>
+> 示例:**https://xxxxxxxxx/api/commit/xxxx**
+
+## 查看提交信息
+
+```http
+get /:commitId
+```
+
+### Response
+
+```ts
+interface CommitData {
+  err: 0;
+  res: CommitSerializer;
+}
+```
+
+see [CommitSerializer](../serializer/CommitSerializer.md)

+ 36 - 0
serializer/CommitSerializer.md

@@ -0,0 +1,36 @@
+# CommitSerializer
+
+提交信息
+
+## Attributes
+
+```ts
+interface CommitSerializer {
+  id?: number;
+  hash?: string;
+  finished?: boolean;
+  score?: number;
+  createdAt?: LocalDateTime;
+  result?: {
+    id?: number;
+    score?: number;
+    exam?: {
+      id?: number;
+      name?: string;
+    };
+    owner?: {
+      id?: number;
+      username?: string;
+    };
+  };
+  records?: Array<{
+    id?: number;
+    status?: BuildStatus;
+    score?: number;
+    problem?: {
+      id?: number;
+      name?: string;
+    };
+  }>;
+}
+```