bulletin board API下載 - bulletin board API源碼下載

bulletin board API

Python

1.0.0

下載

佈告欄

建立用於教育目的的最小可行公告板 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"
    }
}

{
    "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`

姓名	類型	資料類型	描述
身體	必需的	細繩	評論文字

姓名	類型	資料類型	描述
身體	必需的	細繩	評論文字

發射

克隆此存儲庫並轉到您的專案資料夾：

 git 克隆 https://github.com/AllaAverina/bulletin-board-APIcdBulletin-board-API

安裝依賴項：

作曲家安裝

啟動MySQL，在.env.example檔案中修改連接資料庫的參數，然後執行：

複製 .env.example .env

運行命令來運行遷移：

 php 工匠遷移

或者，如果您想用虛擬資料填充資料庫：

 php artisan 遷移 --seed

啟動網頁伺服器：

 php工匠服務

在瀏覽器中打開，例如http://localhost:8000/api/v1/posts

運行測試

建立一個新的資料庫用於測試，更改參數以在 .env.testing 檔案中連接到該資料庫並執行：

 php工匠測試

在 Docker 中運行

克隆此存儲庫並轉到您的專案資料夾：

 git 克隆 https://github.com/AllaAverina/bulletin-board-APIcdBulletin-board-API

安裝依賴項：

 docker 運行--rm
     -u "$(id -u):$(id -g)"
     -v "$(密碼):/var/www/html"
     -w /var/www/html
     laravelsail/php82-composer：最新
     作曲家安裝 --ignore-platform-reqs

建立一個 .env 檔案：

 cp.env.docker.examlpe.env

建立 shell 別名並執行 sail：

別名 sail='[ -f sail ] && sh sail || sh 供應商/bin/sail'sail up -d

運行命令來運行遷移：

風帆工匠遷徙

或者，如果您想用虛擬資料填充資料庫：

風帆工匠遷移--種子

在瀏覽器中打開，例如http://localhost/api/v1/posts
若要停止容器，請使用：

航行停止

在 Docker 中運行測試

設定 .env.testing 檔案：

 cp .env.docker.testing .env.testing

運行測試：

帆工匠測試

展開

附加信息

版本 1.0.0
類型 Python
更新時間 2025-01-07
大小 122.2KB
來自於 Github

相關應用

sample node api

2024-11-05
evolution api

2024-11-03
Board Heroes中文版

2023-10-31
莫諾波利委員會

2023-05-26
加油優惠APP源碼可二開另外底價提供團油API API API

2022-12-06
VcanFly 板 SQLite

2009-04-22

爲您推薦

chat.petals.dev

其他源碼

1.0.0
GPT Prompt Templates

其他源碼

1.0.0
GPTyped

其他源碼

GPTyped 1.0.5
Nuitka

Python

1.0.0
azure storage python

Python

v2.1.0
Google Blog Converters(部落格資料轉換器)

Python

1.0 R54
wp functions

其他類別

1.0.0
waymo open dataset

其他源碼

December 2023 Update
slugify

其他類別

Version 4.6.0 (10 September 2024)

相關資訊全部

bulletin board API

佈告欄

功能性

要求

文件

驗證

身體

成功回應

HTTP 代碼： 201 CREATED

身體

成功回應

HTTP 程式碼： 200 OK

標頭

成功回應

HTTP 代碼： 204 NO CONTENT

輪廓

標頭

回覆

HTTP 程式碼： 200 OK

標頭

參數

回覆

HTTP 程式碼： 200 OK

標頭

參數

成功回應

HTTP 程式碼： 200 OK

使用者

參數

成功回應

HTTP 程式碼： 200 OK

成功回應

HTTP 程式碼： 200 OK

參數

成功回應

HTTP 程式碼： 200 OK

參數

成功回應

HTTP 程式碼： 200 OK

標籤

參數

成功回應

HTTP 程式碼： 200 OK

參數

成功回應

HTTP 程式碼： 200 OK

貼文

參數

成功回應

HTTP 程式碼： 200 OK

參數

成功回應

HTTP 程式碼： 200 OK

標頭

身體

成功回應

HTTP 代碼： 201 CREATED

標頭

身體

成功回應

HTTP 程式碼： 200 OK

標頭

成功回應

HTTP 代碼： 204 NO CONTENT

評論

標頭

身體

成功回應

HTTP 代碼： 201 CREATED

標頭

身體

成功回應

HTTP 程式碼： 200 OK

標頭

成功回應

HTTP 代碼： 204 NO CONTENT

發射

運行測試

在 Docker 中運行

在 Docker 中運行測試

HTTP 代碼： `201` `CREATED`

HTTP 程式碼： `200` `OK`

HTTP 代碼： `204` `NO CONTENT`

HTTP 程式碼： `200` `OK`

HTTP 程式碼： `200` `OK`

HTTP 程式碼： `200` `OK`

HTTP 程式碼： `200` `OK`

HTTP 程式碼： `200` `OK`

HTTP 程式碼： `200` `OK`

HTTP 程式碼： `200` `OK`

HTTP 程式碼： `200` `OK`

HTTP 程式碼： `200` `OK`

HTTP 程式碼： `200` `OK`

HTTP 程式碼： `200` `OK`

HTTP 代碼： `201` `CREATED`

HTTP 程式碼： `200` `OK`

HTTP 代碼： `204` `NO CONTENT`

HTTP 代碼： `201` `CREATED`

HTTP 程式碼： `200` `OK`

HTTP 代碼： `204` `NO CONTENT`