首页>编程相关>Python
下载

布告栏

创建用于教育目的的最小可行公告板 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 克隆 https://github.com/AllaAverina/bulletin-board-APIcdBulletin-board-API

  1. 安装依赖项：

作曲家安装

  1. 启动MySQL，在.env.example文件中修改连接数据库的参数，然后运行：

复制 .env.example .env

  1. 运行命令来运行迁移：

 php 工匠迁移

或者，如果您想用虚拟数据填充数据库：

 php artisan 迁移 --seed

  1. 启动网络服务器：

 php工匠服务

  1. 在浏览器中打开，例如http://localhost:8000/api/v1/posts

运行测试

创建一个新的数据库用于测试，更改参数以在 .env.testing 文件中连接到该数据库并运行：

 php工匠测试

在 Docker 中运行

  1. 克隆此存储库并转到您的项目文件夹：

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

  1. 安装依赖项：

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

  1. 创建一个 .env 文件：

 cp.env.docker.examlpe.env

  1. 创建 shell 别名并运行 sail：

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

  1. 运行命令来运行迁移：

风帆工匠迁徙

或者，如果您想用虚拟数据填充数据库：

风帆工匠迁移--种子

  1. 在浏览器中打开，例如http://localhost/api/v1/posts

  2. 要停止容器，请使用：

航行停止

在 Docker 中运行测试

  1. 设置 .env.testing 文件：

 cp .env.docker.testing .env.testing

  1. 运行测试：

帆工匠测试
展开
附加信息
相关应用
为您推荐
相关资讯 全部