ホーム>プログラミング関連>パイソン
ダウンロード

掲示板

教育目的で最小限の実行可能な掲示板 REST API を作成します。

機能的

  • すべてのタグ、投稿、ユーザーのリストを取得する

  • リスト内で検索する

  • ユーザー登録

  • 登録ユーザーは次のことができます。

    • 新しい投稿を追加する

    • 既存の投稿にコメントする

    • 投稿とコメントを削除および編集する

要件

  • PHP 8.1+

  • ララベル10

  • 作曲家

  • MySQL

ドキュメント

認証

POST /api/v1/auth/register登録する
体
名前タイプデータ型説明
名前必須弦名前
ニックネーム必須弦人間が読める識別子
電子メール必須弦電子メールアドレス
パスワード必須弦パスワード
パスワード_確認済み必須弦パスワードの確認
成功の応答
HTTP コード: 201 CREATED 
{
    "access_token",
    "token_type": "Bearer"
}
POST /api/v1/auth/loginログイン
体
名前タイプデータ型説明
電子メール必須弦電子メールアドレス
パスワード必須弦パスワード
成功の応答
HTTP コード: 200 OK 
{
    "access_token",
    "token_type":"Bearer"
}
POST /api/v1/auth/logoutログアウト
ヘッダー
鍵価値
認可ベアラー {トークン}
成功の応答
HTTP コード: 204 NO CONTENT

プロフィール

GET /api/v1/profile認証されたユーザープロファイルを取得します
ヘッダー
鍵価値
認可ベアラー {トークン}
応答
HTTP コード: 200 OK 
{
    "data": {
        "user_id",
        "name",
        "nickname",
        "email",
        "created_at",
        "updated_at",
        "posts_count",
        "comments_count"
    }
}
GET /api/v1/profile/posts認証されたユーザーのプロフィールと投稿を取得します
ヘッダー
鍵価値
認可ベアラー {トークン}
パラメータ
名前タイプデータ型説明
ページごとオプション整数ページあたりの投稿数
ページオプション整数ページ番号
応答
HTTP コード: 200 OK 
{
    "data": [
        {
            "post_id",
            "title",
            "price",
            "description",
            "created_at",
            "updated_at",
            "user_id",
            "user_nickname",
            "tags": [
                {
                    "tag_id",
                    "name",
                    "slug",
                },
                ...
            ],
            "comments_count"
        }
    ],
    "links": {...},
    "meta": {...},
    "user": {
        "user_id",
        "name",
        "nickname",
        "email",
        "created_at",
        "updated_at"
    }
}
GET /api/v1/profile/comments認証されたユーザーのプロフィールとコメントを取得します
ヘッダー
鍵価値
認可ベアラー {トークン}
パラメータ
名前タイプデータ型説明
ページごとオプション整数ページごとのコメント数
ページオプション整数ページ番号
成功の応答
HTTP コード: 200 OK 
{
    "data": [
        {
            "comment_id",
            "body",
            "created_at":,
            "updated_at",
            "post_id",
            "user_id",
            "user_nickname"
        },
        ...
    ],
    "links": {...},
    "meta": {...},
    "user": {
        "user_id",
        "name",
        "nickname",
        "email",
        "created_at",
        "updated_at"
    }
}

ユーザー

GET /api/v1/usersすべてのユーザーを取得
パラメータ
名前タイプデータ型説明
qオプション弦検索クエリ
ページごとオプション整数ページあたりのユーザー数
ページオプション整数ページ番号
成功の応答
HTTP コード: 200 OK 
{
    "data": [
        {
            "user_id",
            "name",
            "nickname",
            "email",
            "created_at",
            "updated_at",
            "posts_count",
            "comments_count"
        },
        ...
    ],
    "links": {...},
    "meta": {...}
}
GET /api/v1/users/{nickname}ユーザーを取得
成功の応答
HTTP コード: 200 OK 
{
    "data": {
        "user_id",
        "name",
        "nickname",
        "email",
        "created_at",
        "updated_at",
        "posts_count",
        "comments_count"
    }
}
GET /api/v1/users/{nickname}/postsユーザーとその投稿を取得します
パラメータ
名前タイプデータ型説明
ページごとオプション整数ページあたりの投稿数
ページオプション整数ページ番号
成功の応答
HTTP コード: 200 OK 
{
    "data": [
        {
            "post_id",
            "title",
            "price",
            "description",
            "created_at",
            "updated_at",
            "user_id",
            "user_nickname",
            "tags": [
                {
                    "tag_id",
                    "name",
                    "slug"
                },
                ...
            ],
            "comments_count"
        },
        ...
    ],
    "links": {...},
    "meta": {...},
    "user": {
        "user_id",
        "name",
        "nickname",
        "email",
        "created_at",
        "updated_at"
    }
}
GET /api/v1/users/{nickname}/commentsユーザーとそのコメントを取得します
パラメータ
名前タイプデータ型説明
ページごとオプション整数ページごとのコメント数
ページオプション整数ページ番号
成功の応答
HTTP コード: 200 OK 
{
    "data": [
        {
            "comment_id",
            "body",
            "created_at":,
            "updated_at",
            "post_id",
            "user_id",
            "user_nickname"
        },
        ...
    ],
    "links": {...},
    "meta": {...},
    "user": {
        "user_id",
        "name",
        "nickname",
        "email",
        "created_at",
        "updated_at"
    }
}

タグ

GET /api/v1/tagsすべてのタグを取得
パラメータ
名前タイプデータ型説明
qオプション弦検索クエリ
成功の応答
HTTP コード: 200 OK 
{
    "data": [
        {
            "tag_id",
            "name",
            "slug",
            "post_count"
        },
        ...
    ]
}
GET /api/v1/tags/{slug}タグとその投稿を取得します
パラメータ
名前タイプデータ型説明
ページごとオプション整数ページあたりの投稿数
ページオプション整数ページ番号
成功の応答
HTTP コード: 200 OK 
{
    "data": [
        {
            "post_id",
            "title",
            "price",
            "description",
            "created_at",
            "updated_at",
            "user_id",
            "user_nickname"
        },
    ],
    "links": {...},
    "meta": {...},
    "tag": {
        "tag_id",
        "name",
        "slug"
    }
}

投稿

GET /api/v1/postsすべての投稿を取得
パラメータ
名前タイプデータ型説明
qオプション弦検索クエリ
ページごとオプション整数ページあたりの投稿数
ページオプション整数ページ番号
成功の応答
HTTP コード: 200 OK 
{
    "data": [
        {
            "post_id,
            "title",
            "price",
            "description",
            "created_at",
            "updated_at",
            "user_id",
            "user_nickname",
            "tags": [
                {
                    "tag_id",
                    "name",
                    "slug"
                },
                ...
            ],
            "comments_count"
        },
        ...
    ],
    "links": {...},
    "meta": {...}
}
GET /api/v1/posts/{id}投稿とそのコメントを取得します
パラメータ
名前タイプデータ型説明
ページごとオプション整数ページごとのコメント数
ページオプション整数ページ番号
成功の応答
HTTP コード: 200 OK 
{
    "data": [
        {
            "comment_id",
            "body",
            "created_at",
            "updated_at",
            "post_id",
            "user_id",
            "user_nickname"
        },
        ...
    ],
    "links": {...},
    "meta": {...},
    "post": {
        "post_id",
        "title",
        "price",
        "description",
        "created_at",
        "updated_at",
        "user_id",
        "user_nickname",
        "tags": [
            {
                "tag_id",
                "name",
                "slug"
            },
            ...
        ]
    }
}
POST /api/v1/posts新しい投稿を追加
ヘッダー
鍵価値
認可ベアラー {トークン}
体
名前タイプデータ型説明
タイトルオプション弦タイトル
価格オプションフロート価格
説明オプション弦説明
タグ[id]オプション配列[整数]タグIDの配列
成功の応答
HTTP コード: 201 CREATED 
{
    "data": {
        "post_id",
        "title",
        "price",
        "description",
        "created_at",
        "updated_at",
        "user_id",
        "user_nickname",
        "tags": [
            {
                "tag_id",
                "name",
                "slug"
            },
            ...
        ]
    },
}
PUT /api/v1/posts/{id}投稿を編集
ヘッダー
鍵価値
認可ベアラー {トークン}
体
名前タイプデータ型説明
タイトルオプション弦タイトル
価格オプションフロート価格
説明オプション弦説明
タグ[id]オプション配列[整数]タグIDの配列
成功の応答
HTTP コード: 200 OK 
{
    "data": {
        "post_id",
        "title",
        "price",
        "description",
        "created_at",
        "updated_at",
        "user_id",
        "user_nickname",
        "tags": [
            {
                "tag_id",
                "name",
                "slug"
            },
            ...
        ]
    },
}
DELETE /api/v1/posts/{id}投稿を削除します
ヘッダー
鍵価値
認可ベアラー {トークン}
成功の応答
HTTP コード: 204 NO CONTENT

コメント

POST /api/v1/posts/{id}/comments投稿に新しいコメントを追加します
ヘッダー
鍵価値
認可ベアラー {トークン}
体
名前タイプデータ型説明
体必須弦コメントテキスト
成功の応答
HTTP コード: 201 CREATED 
{
    "data": {
        "comment_id",
        "body",
        "created_at",
        "updated_at",
        "post_id",
        "user_id",
        "user_nickname",
    },
}
PUT /api/v1/comments/{id}コメントを編集
ヘッダー
鍵価値
認可ベアラー {トークン}
体
名前タイプデータ型説明
体必須弦コメントテキスト
成功の応答
HTTP コード: 200 OK 
{
    "data": {
        "comment_id",
        "body",
        "created_at",
        "updated_at",
        "post_id",
        "user_id",
        "user_nickname",
    }
}
DELETE /api/v1/comments/{id}コメントを削除します
ヘッダー
鍵価値
認可ベアラー {トークン}
成功の応答
HTTP コード: 204 NO CONTENT

打ち上げ

  1. このリポジトリのクローンを作成し、プロジェクト フォルダーに移動します。

 git clone https://github.com/AllaAverina/bulletin-board-APIcd Bulletin-board-API

  1. 依存関係をインストールします。

作曲家のインストール

  1. MySQL を起動し、.env.example ファイル内のデータベースに接続するためのパラメータを変更して、次を実行します。

 .env.example .env をコピー

  1. コマンドを実行して移行を実行します。

 php 職人の移行

または、データベースにダミー データを入力する場合は、次のようにします。

 php 職人移行 --seed

  1. Web サーバーを起動します。

 php 職人サーブ

  1. ブラウザで開きます (例: http://localhost:8000/api/v1/posts)

テストの実行

テスト用の新しいデータベースを作成し、.env.testing ファイルでそれに接続するためのパラメーターを変更して実行します。

 php職人テスト

Dockerで実行する

  1. このリポジトリのクローンを作成し、プロジェクト フォルダーに移動します。

 git clone https://github.com/AllaAverina/bulletin-board-APIcd Bulletin-board-API

  1. 依存関係をインストールします。

 docker run --rm
     -u "$(id -u):$(id -g)"
     -v "$(pwd):/var/www/html"
     -w /var/www/html
     laravelsail/php82-composer:最新
     コンポーザーのインストール --ignore-platform-reqs

  1. .env ファイルを作成します。

 cp.env.docker.examlpe.env

  1. シェルのエイリアスを作成し、sail を実行します。

エイリアスセイル='[ -f セイル ] && sh セイル || sh ベンダー/bin/sail'sail up -d

  1. コマンドを実行して移行を実行します。

帆職人の移住

または、データベースにダミー データを入力する場合は、次のようにします。

帆職人の移住 --seed

  1. ブラウザで開きます (例: http://localhost/api/v1/posts)

  2. コンテナを停止するには、以下を使用します。

帆止め

Docker でのテストの実行

  1. .env.testing ファイルを設定します。

 cp .env.docker.testing .env.testing

  1. テストを実行します。

帆職人試験
拡大する
追加情報
関連アプリ
おすすめ
関連情報 すべて