markdown todoapp后端api

Posted 2021-05-05

# TODO-API ドキュメント

## タスク一覧を取得
**path**

```
GET /tasks
```

**parameters**

none  

**response**

```
{
	"count":2,
	"tasks":[
		{
			"id":1,
			"name":"clean my room",
			"done":false,
		},
		{
			"id":2,
			"name":"learning programming",
			"done":false,
		}
	]
}
```

## タスクを1個取得

**path**
```
GET /tasks/:id
```

**parameters**
```
id, number, タスクのID
```

**response**
```
{
	{
		"id":1,
		"name":"clean my room",
		"done":false,
	}
}
```

## タスクを追加

**path**
```
POST /tasks
```

**input**

name, string, タスクの項目名  
done, boolean, タスクが完了したかどうか  

**response**
```
{
	"count":2,
	"tasks":[
		{
			"id":1,
			"name":"clean my room",
			"done":false,
		},
		{
			"id":2,
			"name":"learning programming",
			"done":false,
		}
	]
}
```

## タスクを修正
**path**
```
PATCH /tasks/:id
```

**input**
done, boolean, タスクが完了したかどうか。項目名は修正できない  

**response**
```
{
	"count":2,
	"tasks":[
		{
			"id":1,
			"name":"clean my room",
			"done":false,
		},
		{
			"id":2,
			"name":"learning programming",
			"done":false,
		}
	]
}
```

## タスクを削除
**path**
```
DELETE /tasks/:id
```

**parameter**
none  

**response**
```
{
	"count":2,
	"tasks":[
		{
			"id":1,
			"name":"clean my room",
			"done":false,
		},
		{
			"id":2,
			"name":"learning programming",
			"done":false,
		}
	]
}
```

**参考**  
https://qiita.com/mserizawa/items/b833e407d89abd21ee72  
https://developer.github.com/v3/gists/