marlon33 / api-crud-post-blog
一个RESTful API
dev-main
2021-04-26 14:59 UTC
Requires
- php: ^7.4 || ^8.0
- firebase/php-jwt: ^5.2
- mongodb/mongodb: ^1.8
- pimple/pimple: ^3.4
- slim/psr7: ^1.3
- slim/slim: ^4.5
- tuupola/slim-jwt-auth: ^3.5
- vlucas/phpdotenv: ^5.3
Requires (Dev)
- phpunit/phpunit: ^9.5
- symfony/console: ^4.4
This package is not auto-updated.
Last update: 2024-09-24 06:01:16 UTC
README
API RESTful CRUD post para blog,使用 Slim PHP 微框架 和 MongoDB
使用技术: PHP 7, Slim 4, MongoDB, PHPUnit, dotenv。
安装
composer require marlon33/api-crud-post-blog
要求
- Composer.
- PHP 7.4+.
- mongoDB.
Composer
下载仓库或克隆它:依赖项
composer require slim/slim:"^4.5"
composer require mongodb/mongodb
composer require slim/psr7
composer require vlucas/phpdotenv
composer require pimple/pimple
composer require phpunit/phpunit --dev
composer require firebase/php-jwt
composer require tuupola/slim-jwt-auth
- slim/slim:用于构建API的Slim框架。
- mongodb/mongo-php-library:作为数据库使用的MongoDB。
- slim/psr7:用于Slim 4的PSR-7实现。
- vlucas/phpdotenv:自动读取
.env文件到getenv()、$_ENV和$_SERVER。 - pimple/pimple:PHP 依赖注入。
配置MongoDB连接
API默认使用MongoDB
您必须正确配置以下 .env 文件:您可以使用https://mlab.com/plans/pricing/#plan-type=sandbox 作为免费版本数据库。
- iNSTALAÇÃO MONGODB 安装MongoDB。
mongodb+srv://<NameUser>:<password>@cluster0.ng1wy.mongodb.net/<COLLATION>?retryWrites=<TRUE/FALSE>&w=majority
MongoDB_HOST = '<NameUser>:<password>@cluster0.ng1wy.mongodb.net/'
MongoDB_COLLATION = <COLLATION>
MongoDB_RETRY_WRITES = '<TRUE/FALSE>'
MongoDB_W = 'majority'
DISPLAY_ERROR_DETAILS=true
SLIM_BASE_PATH=''
DISPLAY_ERROR_DETAILS 在生产环境中应为 false,在开发环境中为 true。
路由
标准
-
GET /api/api检查API状态和版本 -
GET /api/status检查API状态和版本
CRUD
GET /api/posts查询所有文章并返回一个arrayPOST /api/posts创建文章并返回包含状态和ID的arrayGET /api/posts/{id}通过{id}查询文章并返回一个objetoPUT /api/posts/{id}通过{id}查询文章并更新文章,然后返回一个objetoPOST /api/token查询令牌POST /api/register注册新用户