codeHomework

assignment/serializer/MirrorSerializer.md

@@ -0,0 +1,14 @@
+# ProjectSerializer
+
+代码作业项目的基本信息
+
+## Attributes
+
+- id : **Number** - 代码作业项目 id
+- codeId：**Number** - 代码作业 id
+- url : **String** - 项目 git 地址
+- name : **String** - 项目名称
+- buildIdList：**`List<Number>`** - 构建 IDlist
+- deployIdList：**`List<Number>`** - 部署 IDlist
+- unitTestIdList：**`List<Number>`** - 单元测试 IDlist
+- functionTestIdList：**`List<Number>`** - 页面功能测试 IDlist

assignment/serializer/ProjectSerializer.md

@@ -6,9 +6,9 @@
 
 - id : **Number** - 代码作业项目 id
 - codeId：**Number** - 代码作业 id
-- url : **String** - 项目git地址
+- url : **String** - 项目 git 地址
 - name : **String** - 项目名称
-- buildIdList：**```List<Number>```** - 构建IDlist
-- deployIdList：**```List<Number>```** - 部署IDlist
-- unitTestIdList：**```List<Number>```** - 单元测试IDlist
-- functionTestIdList：**```List<Number>```** - 页面功能测试IDlist
+- buildIdList：**`List<Number>`** - 构建 IDlist
+- deployIdList：**`List<Number>`** - 部署 IDlist
+- unitTestIdList：**`List<Number>`** - 单元测试 IDlist
+- functionTestIdList：**`List<Number>`** - 页面功能测试 IDlist

codeHomework/README.md

@@ -0,0 +1,12 @@
+### 负责人
+
+- 【后端】徐翔哲
+- 【前端】吴新宇
+
+### 修改记录
+
+| 修改人 | 修改内容          | 修改时间   |
+| ------ | ----------------- | ---------- |
+| 吴新宇 | 初始化api         | 2018/12/18 |
+| 吴新宇 | 新增很多问题TODO  | 2018/12/24 |
+| 吴新宇 | fix todo 新增异常 | 2018/12/28 |

codeHomework/api/index.md

@@ -0,0 +1,198 @@
+# - 代码作业
+
+> url 前缀：**codehw**
+>
+> 示例：**https://xxxxxxxxx/api/codehw/xxxx**
+
+## 获得某个 Homework 的 Project 列表（应该只有一个）
+
+```http
+post /projects
+```
+
+### Parameters
+
+```json
+{
+  "homeworkId": string
+}
+```
+
+### Response
+
+```json
+{
+  "data": [{ "projectId": string, "description": string }]
+}
+```
+
+## 获得 Project 的详细信息
+
+```http
+get /project/:id
+```
+
+### Response
+
+```json
+{
+  "id": string,
+  "data": ProjectSerializer
+}
+```
+
+see [ProjectSerializer](../serializer/ProjectSerializer.md)
+
+## 获得一次构建的详细信息
+
+```http
+get /build/:id
+```
+
+### Response
+
+```json
+{
+  "id": string,
+  "data": BuildSerializer
+}
+```
+
+see [BuildSerializer](../serializer/BuildSerializer.md)
+
+## 获得一次部署的详细信息
+
+```http
+get /deploy/:id
+```
+
+### Response
+
+```json
+{
+  "id": string,
+  "data": DeploySerializer
+}
+```
+
+see [DeploySerializer](../serializer/DeploySerializer.md)
+
+## 获得一次单元测试的详细信息
+
+```http
+get /unit/:id
+```
+
+### Response
+
+```json
+{
+  "id": string,
+  "data": UnitTestSerializer
+}
+```
+
+see [UnitTestSerializer](../serializer/UnitTestSerializer.md)
+
+## 获得一次页面功能测试的详细信息
+
+```http
+get /functional/:id
+```
+
+### Response
+
+```json
+{
+  "id": string,
+  "data": FunctionalTestSerializer
+}
+```
+
+see [FunctionalTestSerializer](../serializer/FunctionalTestSerializer.md)
+
+## 获得可用镜像的 ID
+
+```http
+get /mirrors/:homeworkId/:projectId
+```
+
+### Response
+
+```json
+{
+  "data": [{{mirrorID:string, url:string, description: string},{...}]
+}
+```
+
+## 触发一次部署
+
+```http
+post /deploy
+```
+
+### Parameters
+
+```json
+{
+  "homeworkId": string,
+  "projectId": string,
+  "mirrorId": string,
+  "arguments": { TBD }
+}
+```
+
+### Response
+
+```json
+{
+  "data": { "success": boolean }
+}
+```
+
+## 触发一次单元测试
+
+```http
+post /unit
+```
+
+### Parameters
+
+```json
+{
+  "homeworkId": string,
+  "projectId": string
+}
+```
+
+### Response
+
+```json
+{
+  "data": { "success": boolean }
+}
+```
+
+## 触发一次页面功能测试
+
+```http
+post /functional
+```
+
+### Parameters
+
+```json
+{
+  "homeworkId": string,
+  "projectId": string,
+  "deployId": string
+}
+```
+
+### Response
+
+```json
+{
+  "data": { "success": boolean }
+}
+```

codeHomework/serializer/BuildSerializer.md

@@ -0,0 +1,12 @@
+# BuildSerializer
+
+代码作业一次构建的基本信息
+
+## Attributes
+
+- id : **Number** - 代码作业一次构建的 id
+- branchId：**String** - 分支 id
+- buildState : **Number** - 构建状态[0:"构建中",1:"构建成功",-1:"构建失败"]
+- buildMessage : **String** - 构建输出的信息
+- mirrorId: **String** - 镜像 id （构建成功之后产生）
+- commitMessage **String** commit 信息

codeHomework/serializer/DeploySerializer.md

@@ -0,0 +1,11 @@
+# DeploySerializer
+
+代码作业一次部署的基本信息
+
+## Attributes
+
+- id : **Number** - 代码作业一次部署的 id
+- buildState : **Number** - 部署状态[0:"部署中",1:"部署成功",-1:"部署失败"]
+- buildMessage : **String** - 构建输出的信息
+- config: **Json** - 配置信息{TBD}
+- pageUrl **String** - 项目部署的 url

codeHomework/serializer/FunctionalTestSerializer.md

@@ -0,0 +1,20 @@
+# FunctionalTestSerializer
+
+代码作业一次功能测试的基本信息
+
+## Attributes
+
+- id : **Number** - 代码作业一次单元测试的 id
+- time: **TimeStamp** - 测试时间
+- deployId : **String** - 对应的部署 id
+- detail: **`List<OneFunctionalTestSerializer>`** - 未通过的测试用例列表
+
+# OneFunctionalSerializer
+
+代码作业一次页面功能测试一个测试用例的基本信息
+
+## Attributes
+
+- id : **Number** - 一个测试用例的 id
+- isPass: **boolean** - 是否通过
+- message : **String** - 输出

codeHomework/serializer/ProjectSerializer.md

@@ -0,0 +1,16 @@
+# ProjectSerializer
+
+代码作业项目的基本信息
+
+## Attributes
+
+- id : **Number** - 代码作业项目 id
+- codeId：**Number** - 代码作业 id
+- url : **String** - 项目 git 地址
+- name : **String** - 项目名称
+- buildIdList：**`List<Number>`** - 构建 IDlist
+- deployIdList：**`List<Number>`** - 部署 IDlist
+- unitTestIdList：**`List<Number>`** - 单元测试 IDlist
+- functionTestIdList：**`List<Number>`** - 页面功能测试 IDlist
+
+see [ProjectSerializer](../assignment/serializer/ProjectSerializer.md)

codeHomework/serializer/UnitTestSerializer.md

@@ -0,0 +1,9 @@
+# MirrorSerializer
+
+代码作业镜像的基本信息
+
+## Attributes
+
+- id : **Number** - 镜像的 id
+- gitUrl: **String** - git 仓库地址
+- downloadUrl : **String** - 镜像下载地址