mms80/todo-api

todo api

维护者

详情

github.com/mms80/todo-api

源代码

问题

安装: 3

依赖: 0

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 0

公开问题: 0

dev-master 2022-07-08 17:41 UTC

Requires

Requires (Dev)

MIT 9db6d99a36b0f468860f5e9824daab466343f1fe

  • Mahdi Sedighian <m.mahdi.sedighian.woop@gmail.com>

This package is not auto-updated.

Last update: 2024-09-28 06:48:20 UTC

README

此项目是为了Laravel设计的，用于创建一个独立于项目的包，该包可以为主项目添加待办功能。最后，在将您的包文件复制到主项目并添加到composer后，您的包应连接到主项目，并为该项目启用待办功能。

安装

  composer require mms80/todo-api

需求

  • PHP ^7.4
  • Laravel ^7.x

环境

文档

  • 在数据库中创建表

      php artisan migrate

  • 在数据库中创建用户。

  • 所有请求必须在头部包含"Authorization"参数（Authorization的值是一个Bearer TOKEN）。

  • 在".env"文件中配置"mailtrap"环境。

任务API

  • 显示登录用户的全部任务

      GET "/tasks"

  • 创建任务

      POST "/tasks" -d {"title":"foo","description":"bar","labels --optional":["label1","label2"]}

  • 显示任务

      GET "/tasks/{id}"

  • 编辑任务

      PUT "/tasks/{id}" -d {"title --optional":"foo" , "description --optional":"bar" , "status --optional":"1 || 2" , "labels --optional":["label1","label2"] , "detaching --optional":true}

    当"status"为"1"时，任务处于打开状态，当"status"为"2"时，任务处于关闭状态。

    "detaching"是一个可选参数。当其为true时，新标签被添加到任务中，旧标签被删除；当其为false时，新标签被添加到旧任务标签中（默认为false）。

标签API

  • 显示所有标签

      GET "/labels"

  • 创建标签

      POST "/labels" -d {"title --unique":"foo"}

测试

在包文件夹路径中

composer update
composer run test