使用 Dart 构建的 REST API

此 API 提供用于身份验证和管理用户帖子的端点。它使用 Dart 编程语言构建，并连接到 Firebase 进行身份验证和 MongoDB Atlas 存储数据。

先决条件

  • Dart SDK
  • Firebase 账户和 API 凭证
  • MongoDB Atlas 账户和集群连接信息

Postman 工作区 URL

Postman

端点

健康检查

  • GET / 检查服务器是否正在运行

认证

  • POST /api_v1/auth/signup 创建新的用户账户
  • POST /api_v1/auth/signin 登录现有用户账户
  • GET /api_v1/auth/checkauth 检查用户的令牌是否有效且未过期
  • POST /api_v1/auth/resetpassword 重置用户账户的密码

用户

  • POST /api_v1/user/newpost 创建新帖子
  • GET /api_v1/user/allposts 检索所有帖子
  • GET /api_v1/user/myposts 检索当前用户的的所有帖子
  • GET /api_v1/user/post/ 通过 id 检索特定帖子
  • GET /api_v1/user/mypost/ 通过 id 检索属于当前用户的特定帖子
  • PUT /api_v1/user/updatepost/ 通过 id 更新属于当前用户的特定帖子
  • DELETE /api_v1/user/deletepost/ 通过 id 删除属于当前用户的特定帖子

服务

该项目已连接到以下服务

  • Firebase：用于用户身份验证。
  • MongoDB Atlas：用于存储和检索数据。

设置

设置您的 Firebase 凭证

在项目根目录创建一个名为 firebase.json 的文件，并添加您的 Firebase API 密钥和其他相关信息。

运行 API

要运行 API，请使用以下命令

  1. 克隆仓库
git clone https://github.com/fahad0100/Example-of-building-a-Restful-API-in-the-Dart-.git
  1. 进入项目目录
cd Example-of-building-a-Restful-API-in-the-Dart-
  1. 安装依赖项
dart pub get
  1. 运行服务器
dart bin/server.dart

贡献

我们欢迎为本项目做出贡献。如果您有改进的想法或要报告的错误，请打开一个 issue。如果您想自己进行更改，请遵循以下步骤：

  1. Fork该存储库。
  2. 为您的更改创建一个新分支。
  3. 进行更改。
  4. 提交您的更改并推送到您的分支。
  5. 打开一个 pull request。

您也可以通过 [email protected] 联系我进行进一步讨论。

部署

该 API 托管在 GitHub 上，并已部署在 Heroku 上，地址为 Api

GitHub

查看 Github