colycao / todo-laravel-dingo-api-swagger Goto Github PK

View Code? Open in Web Editor NEW

0.0 1.0 0.0 2.01 MB

「TODOリスト」LaravelでのAPI実装

Home Page: https://todo-laravel-dingo-api-swagger.herokuapp.com/

Shell 0.39% Procfile 0.01% PHP 92.35% Blade 7.24%

dingo-api l5-swagger laravel laravel-admin pest-plugin pestphp phpunit

todo-laravel-dingo-api-swagger's Introduction

「TODOリスト」LaravelでAPI実装

シンプルなAPIは、Laravelで構築されたToDoリストを管理する。

TODO（やること）を登録できる
登録したTODOを変更できる
登録したTODOを削除できる
登録されているTODOを一覧で表示できる
登録したTODOの完了状態をメモする

Requirements

PHP 7.3 or higher
Laravel 8.0 or higher

Installation

Clone the repo locally:

git clone [email protected]:colyii/clara-coly-todo.git
cd clara-coly-todo

Install dependencies
```
composer install
```
Copy the contents of .env.example to a .env file, or simply run this command:
```
# Mac Linux
cp .env.example .env
# Windows
copy .env.example .env
```
Generate application key (if not already generated)
```
php artisan key:generate
```
Run database migrations
```
php artisan migrate
```
Run database seed
```
php artisan db:seed
```
Run the dev server (the output will give the address):
```
php artisan serve --host=127.0.0.1 --port=8000
```

Running tests

./vendor/bin/pest --filter TodoTest

php artisan test

返回结果

// 成功
{
    "success": 1,
    "message": "TODOを表示しました。",
    "status_code": 200,
    "data": {
        "id": 4,
        ...
        "created_at": "2022-08-24 00:12:47",
        "updated_at": "2022-08-24 00:12:47",
        ...
    }
}

// 失败
{
    "success": 0,
    "message": "TODO情報が見つかりませんでした。",
    "status_code": 404
}