Git Product home page Git Product logo

api-comentarios-postagens's Introduction

API para comentários em postagens

API desenvolvida para o processo seletivo da eSapiens utilizando PHP (Laravel) e PostgreSQL

Autor

Lucas T. A. Gouvêa

Endpoints principais

  • (POST) /api/postagens Criar uma postagem;

  • (POST) /api/postagens/{id}/comentar Comentar em uma postagem (controlado por throttle, máximo de 10 requisições por minuto e por uma permissão chamada comentar-postagem);

  • (POST) /api/comentarios/{id}/excluir Exclusão de comentário.

  • (GET) /api/postagens/{id}/comentarios Listar todos os comentários de uma postagem (controlado por throttle, máximo de requisições de 20 por minuto);

  • (GET) /api/comentarios_do_usuario Listar todos os comentários de um usuário;

  • (GET) /api/notifications Listar notificações de um usuário (as notificações expiram em 72h);

Instalação

  • Clonar o repositório
  • Rodar dentro do diretório do repo:
cp .env.example .env
docker-compose exec app composer install
docker-compose exec app chmod -R 775 storage
docker-compose exec app php artisan key:generate
docker-compose exec app php artisan config:cache
docker-compose exec app php artisan migrate:fresh --seed
docker-compose exec app php artisan passport:install

Caso prefira, há um script na raiz chamado app-install.sh com as mesmas instruções.

O server ficará escutando na porta 8000.

Autenticação

Rota /api/login Header: application/x-www-form-urlencoded Corpo do request:

    grant_type:password
    client_id:2
    client_secret:PTGXNTsKwf1EOE2r6TAQaU9caqlZLHufKnQSApuC
    username:admin
    password:123456
    scope:

Documentação

Foi gerada uma documentação pelo Phpdox em /docs/html.

Também há uma collection de requests para o Postman em /docs/api-postagens.postman_collection.json, para usar basta importá-la no Postman, colocar o client secret gerado pelo Passport no corpo do request de login e inicializar uma váriavel de ambiente chamada token_sapiens com o valor do access_token na resposta desse endpoint. Todos os demais requests vão utilizar o token nessa variável.

api-comentarios-postagens's People

Contributors

ltgouvea avatar wellcda avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.