# - 代码作业

> url 前缀：**codehw**
>
> 示例：**https://xxxxxxxxx/api/codehw/xxxx**

## 获得某个 Homework 的 Project 列表（应该只有一个）

```http
post /projects
```

### Parameters

```json
{
  "homeworkId": string
}
```

### Response

```json
{
  "data": [{ "projectId": string, "name": 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": MirrorSerializer[]
}
```

## 触发一次部署

```http
post /deploy
```

### Parameters

```json
{
  "homeworkId": string,
  "projectId": string,
  "mirrorId": string,
  "arguments": { TBD }
}
```

### Response

```json
{
  "data": { "success": boolean }
}
```

## 触发一次页面功能测试

```http
post /functional
```

### Parameters

```json
{
  "homeworkId": string,
  "projectId": string,
  "deployId": string
}
```

### Response

```json
{
  "data": { "success": boolean }
}
```