todo_api

备忘录api


添加一条新的待办事项

<h5>简要描述</h5> <ul> <li>无</li> </ul> <h5>请求URL</h5> <ul> <li><code>http://127.0.0.1:5000/todo/api/v1.0/tasks</code> </li> </ul> <h5>请求方式</h5> <ul> <li>post</li> </ul> <h5>请求Body参数</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">是</td> <td>string</td> <td>标题</td> </tr> <tr> <td style="text-align: left;">body</td> <td style="text-align: left;">否</td> <td>string</td> <td>内容(默认为空)</td> </tr> <tr> <td style="text-align: left;">state</td> <td style="text-align: left;">否</td> <td>int</td> <td>完成状态(1为已完成;0为待办)(默认未完成)</td> </tr> <tr> <td style="text-align: left;">start_time</td> <td style="text-align: left;">否</td> <td>string</td> <td>添加时间(格式为%m/%d/%y %H:%M:%S,默认为当前时刻)</td> </tr> <tr> <td style="text-align: left;">deadline</td> <td style="text-align: left;">否</td> <td>string</td> <td>截止时间(格式为%m/%d/%y %H:%M:%S,默认为添加后7天)</td> </tr> </tbody> </table> <h5>成功返回示例</h5> <pre><code>{ "message": "Created", "notes": { "body": "添加一条新的待办事项", "deadline": "Mon, 17 Jan 2022 02:11:13 -0000", "id": 32, "start_time": "Mon, 17 Jan 2022 02:11:12 -0000", "state": true, "title": "添加一条新的待办事项" }, "status": 200 } </code></pre> <h5>成功返回示例的参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">message</td> <td style="text-align: left;">string</td> <td>描述状态信息</td> </tr> <tr> <td style="text-align: left;">notes</td> <td style="text-align: left;">object</td> <td>数据</td> </tr> <tr> <td style="text-align: left;">body</td> <td style="text-align: left;">string</td> <td>内容</td> </tr> <tr> <td style="text-align: left;">deadline</td> <td style="text-align: left;">string</td> <td>截止时间</td> </tr> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">string</td> <td>id</td> </tr> <tr> <td style="text-align: left;">start_time</td> <td style="text-align: left;">string</td> <td>添加时间</td> </tr> <tr> <td style="text-align: left;">state</td> <td style="text-align: left;">string</td> <td>完成状态(true为已完成;false为待办)</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">string</td> <td>标题</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">string</td> <td>状态码</td> </tr> </tbody> </table> <h5>失败返回示例</h5> <pre><code>{ "message": { "title": "No task title provided" } } </code></pre> <h5>失败返回示例的参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">message</td> <td style="text-align: left;">string</td> <td>“title“不可为空</td> </tr> </tbody> </table>

页面列表

ITEM_HTML