marlon33/api-crud-post-blog

Uma Api RESTful

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

MIT

• Marlon Braga

README

API RESTful CRUD post para blog, usando Slim PHP micro framework e MongoDB

Used technologies: PHP 7, Slim 4, MongoDB, PHPUnit, dotenv.

INSTALAÇÃO:

composer require marlon33/api-crud-post-blog

Requisitos:

• Composer.
• PHP 7.4+.
• mongoDB.

Composer:

Baixe o repositório ou clone ele: Dependencias

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: Slim Framework utilizado para a construção da API.
• mongodb/mongo-php-library: MongoDB Utilizado como Banco de Dados.
• slim/psr7: PSR-7 implementação para utilizar com o Slim 4.
• vlucas/phpdotenv: Ler o arquivo .env para getenv(), $_ENV e $_SERVER automaticamente.
• pimple/pimple: Injeção de dependência php.

Configure a conexão com o MongoDB:

Api utiliza por padrão o MongoDB

Você deve configurar corretamente o arquivo .env conforme abaixo: Você pode utilizar o https://mlab.com/plans/pricing/#plan-type=sandbox como banco de dados, versão gratuita.

• iNSTALAÇÃO MONGODB Instalação mongoDDB.

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 deve ser false em produção, true somente em desenvolvimento.

Rotas:

PADRÃO:

• GET /api/api Verifica a o estado da API e sua versão

• GET /api/status Verifica a o status da API e sua versão

CRUD:

• GET /api/posts Busca todos os posts e retorna um array
• POST /api/posts Cria um post e retorna array contendo o STATUS e o ID
• GET /api/posts/{id} Busca o post pelo {id} e retorna um objeto
• PUT /api/posts/{id} Busca o post pelo {id} atualiza o post e retorna um objeto
• POST /api/token Busca token
• POST /api/register Cadastra novo usuario

DOCUMENTAÇÃO OFICIAL

• MongoDB
• Slim Framework

DOCUMENTAÇÃO API

• DOCUMENTAÇÃO DE USO