Essa aplicação trata-se de uma pequena API para o gerenciamento de agendamentos de uma barbearia fictícia chamada GoBarber. Essa aplicação faz parte do curso GoStack - Bootcamp da Rocketseat.
\nIndica-se o uso de containers para o gerenciamento dos bancos de dados utilizados pela API. Para a execução dos próximos comandos é necessário que o docker tenha sido instalado previamente.
\ndocker run --name gobarber-postgres -e POSTGRES_PASSWORD=password -p 5432:5432 -d postgres\nUsando linha de comando ou uma interface crie um banco no container criado. O nome do banco criado será usado posteriormente nas variáveis de ambiente.
\ndocker run --name gobarber-mongo -p 27017:27017 -e MONGO_INITDB_ROOT_USERNAME=username -e MONGO_INITDB_ROOT_PASSWORD=password -d mongo\ndocker run --name gobarber-redis -p 6379:6379 -d -t redis:alpine\nOBS1: O mailtrap foi utilizado para realizar os testes de envio de e-mail, dessa forma, caso deseje utilizar outra ferramenta será necessário realizar as configurações indicadas pela ferramenta. Caso prefira permanecer com os testes no mailtrap basta criar uma conta em https://mailtrap.io/ e informar as credenciais de acesso no arquivo .env
\nApós clonar o projeto entre na pasta gobarber-api gerada. Renomei o arquivo .env.example para .env e informe os valores das variáveis de ambiente.
\nPara rodar localmente o projeto informe os seguintes valores:
\nAPP_URL=localhost\nAPP_PORT=3333\nAs variáveis abaixo serão utilizadas para criptografar/descriptografar senhas e definir o tempo de validade do token gerado ao iniciar uma sessão. O valor de expiração pode estar em segundos ou em dias. Ex: EXPIRED_IN=2d.
\nSECRET=\nEXPIRED_IN=\nNo banco postgres o valor do USERNAME por padrão é postgres.
\nDB_USERNAME=postgres\nCrie uma conta no Sentry para acompanhar os logs de erros da aplicação. Informe a url DSN do projeto criado no Sentry na variável SENTRY_DSN.
\n*Caso deseje desativar esse recurso as linhas de import do Sentry e sentryConfig, em app.js, devem ser comentadas.
\nSENTRY_DSN=\nyarn\nyarn sequelize db:migrate\nyarn start\nCriar usuário
\n","urlObject":{"path":["users"],"host":["localhost:3333"],"query":[],"variable":[]}},"response":[{"id":"18de2e37-d159-4650-b01f-df9a9d3843c7","name":"Criar usuário","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\":\"Nome do Usuário\",\n\t\"email\":\"usuario@email.com\",\n\t\"password\": \"123456\",\n\t\"provider\": true\n}"},"url":"localhost:3333/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"78"},{"key":"ETag","value":"W/\"4e-lk/KbFy8rxKcX/Ds/wjsyneD91U\""},{"key":"Date","value":"Thu, 23 Apr 2020 01:40:55 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 4,\n \"name\": \"Nome do Usuário\",\n \"email\": \"usuario@email.com\",\n \"provider\": true\n}"}],"_postman_id":"22b30c79-ce05-45a2-a2fb-497f297d0c4e"},{"name":"updateUser","id":"f2b4d3c4-2d36-4d34-8c3e-6d53de24e727","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\":\"usuario@email.com\",\n\t\"avatar_id\": 2\n}"},"url":"localhost:3333/users","description":"Atualizar dados do usuário
\n","urlObject":{"path":["users"],"host":["localhost:3333"],"query":[],"variable":[]}},"response":[{"id":"17b0dfb9-ae92-49e6-a331-2d68df70a050","name":"Atualizar dados do usuário","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"email\":\"usuario@email.com\",\n\t\"avatar_id\": 2\n}"},"url":"localhost:3333/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"215"},{"key":"ETag","value":"W/\"d7-3PGksvwY7GSj5zukXMMVkI1RB0E\""},{"key":"Date","value":"Thu, 23 Apr 2020 01:56:16 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 4,\n \"name\": \"Nome do Usuário\",\n \"email\": \"usuario@email.com\",\n \"avatar\": {\n \"url\": \"http://localhost:3333/files/3b3e62d9eb4ed51e8546607de20cdeaa2bda73c9.jpg\",\n \"id\": 2,\n \"path\": \"3b3e62d9eb4ed51e8546607de20cdeaa2bda73c9.jpg\"\n }\n}"}],"_postman_id":"f2b4d3c4-2d36-4d34-8c3e-6d53de24e727"}],"id":"7c365659-643a-402f-a40c-8b965c37909f","description":"Gerenciamento de usuários da aplicação
\n","_postman_id":"7c365659-643a-402f-a40c-8b965c37909f"},{"name":"Session","item":[{"name":"createSession","id":"e662e7fe-1aa5-4ee7-b708-aca56e0a9d97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\":\"usuario@email.com\",\n\t\"password\": \"123456\"\n}"},"url":"localhost:3333/sessions","description":"Ciar sessão e obter dados de autenticação
\n","urlObject":{"path":["sessions"],"host":["localhost:3333"],"query":[],"variable":[]}},"response":[{"id":"ae310715-3723-4a0e-a6b6-a7f55bd24823","name":"Criar sessão","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"email\":\"usuario@email.com\",\n\t\"password\": \"123456\"\n}"},"url":"localhost:3333/sessions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"388"},{"key":"ETag","value":"W/\"184-Ecxlrf44L9cNaU9NOQu8Qq+pzmA\""},{"key":"Date","value":"Thu, 23 Apr 2020 01:57:38 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"user\": {\n \"id\": 4,\n \"name\": \"Nome do Usuário\",\n \"email\": \"usuario@email.com\",\n \"provider\": true,\n \"avatar\": {\n \"url\": \"http://localhost:3333/files/3b3e62d9eb4ed51e8546607de20cdeaa2bda73c9.jpg\",\n \"id\": 2,\n \"path\": \"3b3e62d9eb4ed51e8546607de20cdeaa2bda73c9.jpg\"\n }\n },\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NCwiaWF0IjoxNTg3NjA3MDU4LCJleHAiOjE1ODc2OTM0NTh9.RbblC2Vuy_OEjIOB-MlriuN6FKiQNuuxxZ43-2XFbL4\"\n}"}],"_postman_id":"e662e7fe-1aa5-4ee7-b708-aca56e0a9d97"}],"id":"8f4afdb4-cc15-4a54-9ac9-4bf2f0bbc429","description":"Iniciar uma sessão
\n","_postman_id":"8f4afdb4-cc15-4a54-9ac9-4bf2f0bbc429"},{"name":"Providers","item":[{"name":"getProviders","id":"c2a53c60-ebf0-4a10-849c-7fca84736dbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"localhost:3333/providers","description":"Obter lista
\n","urlObject":{"path":["providers"],"host":["localhost:3333"],"query":[],"variable":[]}},"response":[{"id":"1e21fffe-d52f-4e9b-8bc5-332ffc819f56","name":"Obter Provedores de serviço","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"localhost:3333/providers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"577"},{"key":"ETag","value":"W/\"241-ONxlQAyIevNfelCwcFJPTVycZj4\""},{"key":"Date","value":"Thu, 23 Apr 2020 01:58:53 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Joziélio Santiago\",\n \"email\": \"jozieliosantiago@gmail.com\",\n \"avatar_id\": 1,\n \"avatar\": {\n \"url\": \"http://localhost:3333/files/fd06bd0ff7596646604c169d1e8383b01c6277e3.jpg\",\n \"name\": \"eu.jpg\",\n \"path\": \"fd06bd0ff7596646604c169d1e8383b01c6277e3.jpg\"\n }\n },\n {\n \"id\": 4,\n \"name\": \"Nome do Usuário\",\n \"email\": \"usuario@email.com\",\n \"avatar_id\": 2,\n \"avatar\": {\n \"url\": \"http://localhost:3333/files/3b3e62d9eb4ed51e8546607de20cdeaa2bda73c9.jpg\",\n \"name\": \"photo.jpg\",\n \"path\": \"3b3e62d9eb4ed51e8546607de20cdeaa2bda73c9.jpg\"\n }\n },\n {\n \"id\": 3,\n \"name\": \"Fulano\",\n \"email\": \"exemplo@email.com\",\n \"avatar_id\": null,\n \"avatar\": null\n }\n]"}],"_postman_id":"c2a53c60-ebf0-4a10-849c-7fca84736dbb"}],"id":"ba0322c8-d5c0-47a9-80f2-ebc666aca26f","description":"Obter lista dos provedores de serviço cadastrados
\n","_postman_id":"ba0322c8-d5c0-47a9-80f2-ebc666aca26f"},{"name":"Files","item":[{"name":"sendFile","id":"4e7802e4-fa87-48a8-8e25-f86820f306fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"multipart/form-data"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","warning":"This file resides outside the working directory. Collaborators might not have the same file path.","src":"/home/jozieliosantiago/Pictures/photo.jpg"}]},"url":"localhost:3333/files","description":"Enviar avatar do usuário
\n","urlObject":{"path":["files"],"host":["localhost:3333"],"query":[],"variable":[]}},"response":[{"id":"cfbafd32-ce39-4b2d-819c-c5caca984782","name":"Enviar foto","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"multipart/form-data"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","warning":"This file resides outside the working directory. Collaborators might not have the same file path.","src":"/home/jozieliosantiago/Pictures/photo.jpg"}]},"url":"localhost:3333/files"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"240"},{"key":"ETag","value":"W/\"f0-f6qa/rQx0JD83vPjBF9FS9apkDw\""},{"key":"Date","value":"Thu, 23 Apr 2020 01:48:37 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"url\": \"http://localhost:3333/files/3b3e62d9eb4ed51e8546607de20cdeaa2bda73c9.jpg\",\n \"id\": 2,\n \"name\": \"photo.jpg\",\n \"path\": \"3b3e62d9eb4ed51e8546607de20cdeaa2bda73c9.jpg\",\n \"updatedAt\": \"2020-04-23T01:48:37.454Z\",\n \"createdAt\": \"2020-04-23T01:48:37.454Z\"\n}"}],"_postman_id":"4e7802e4-fa87-48a8-8e25-f86820f306fe"}],"id":"fa070d81-0cbb-4c9a-90d1-e9ad5e1381a3","description":"Enviar arquivos de imagem
\n","_postman_id":"fa070d81-0cbb-4c9a-90d1-e9ad5e1381a3"},{"name":"Appointments","item":[{"name":"createAppointment","id":"e92d78da-48a8-41a8-85f6-023391400db9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"provider_id\": 3,\n\t\"date\": \"2020-04-30T09:00:00-03:00\"\n}"},"url":"localhost:3333/appointments","description":"Agendar horário
\n","urlObject":{"path":["appointments"],"host":["localhost:3333"],"query":[],"variable":[]}},"response":[{"id":"4313768d-8732-40b4-a680-647e88375df4","name":"Agendar horário","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"provider_id\": 3,\n\t\"date\": \"2020-04-30T09:00:00-03:00\"\n}"},"url":"localhost:3333/appointments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"198"},{"key":"ETag","value":"W/\"c6-ErdT9Vg9hjIZ6Caa4dDcZdd3ai0\""},{"key":"Date","value":"Thu, 23 Apr 2020 02:03:17 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"past\": false,\n \"cancelable\": true,\n \"id\": 2,\n \"user_id\": 4,\n \"provider_id\": 3,\n \"date\": \"2020-04-30T12:00:00.000Z\",\n \"updatedAt\": \"2020-04-23T02:03:17.841Z\",\n \"createdAt\": \"2020-04-23T02:03:17.841Z\",\n \"canceled_at\": null\n}"}],"_postman_id":"e92d78da-48a8-41a8-85f6-023391400db9"},{"name":"deleteAppointment","id":"67af4320-8632-4010-bc36-0820a5a8b46c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"localhost:3333/appointments/:appointment_id","description":"Cancelar horário agendado
\nVariáveis obrigatórias
\nObter lista de horários agendados
\nParâmetros opcionais
\nAgendamento/Cancelamento de horário
\n","_postman_id":"46c9e2dd-8d34-41e0-a53e-473c667a2af9"},{"name":"Schedule","item":[{"name":"getList","id":"01bdc0e0-afd2-4b36-bf4e-7970c0c29ae8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"localhost:3333/schedule?date=2020-04-30T00:00:00-03:00","description":"Obter lista por data
\nParâmetros obrigatórios
\nObter lista de horários agendados do provedor
\n","_postman_id":"a6b38163-b983-41b8-8e98-50b8aea8c6c1"},{"name":"Notifications","item":[{"name":"getList","id":"12e965fb-69a6-49d5-ba39-a7b7605d3bf6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"localhost:3333/notifications","description":"Obter notificações
\n","urlObject":{"path":["notifications"],"host":["localhost:3333"],"query":[],"variable":[]}},"response":[{"id":"be156c06-8d9b-4753-95ac-19df2b39fa8b","name":"Lista de notificações","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"localhost:3333/notifications"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"442"},{"key":"ETag","value":"W/\"1ba-ySZuX6YCl3NMHr5df9bzNonh660\""},{"key":"Date","value":"Thu, 23 Apr 2020 23:16:04 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"read\": false,\n \"_id\": \"5ea0f908d10a6916e1985ee0\",\n \"content\": \"Novo agendamento de Fulano para dia 30 de abril, às 10:00h\",\n \"user\": 4,\n \"createdAt\": \"2020-04-23T02:10:16.036Z\",\n \"updatedAt\": \"2020-04-23T02:10:16.036Z\",\n \"__v\": 0\n },\n {\n \"read\": false,\n \"_id\": \"5ea0f8ded10a6916e1985edf\",\n \"content\": \"Novo agendamento de Joziélio Santiago para dia 30 de abril, às 9:00h\",\n \"user\": 4,\n \"createdAt\": \"2020-04-23T02:09:34.643Z\",\n \"updatedAt\": \"2020-04-23T02:09:34.643Z\",\n \"__v\": 0\n }\n]"}],"_postman_id":"12e965fb-69a6-49d5-ba39-a7b7605d3bf6"},{"name":"updateNotification","id":"30bae76a-b4dd-471e-8387-cee6125745e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"localhost:3333/notifications/:notification_id","description":"Marcar notificação como lida
\nVariáveis obrigatórias
\nObter lista de notificações. As notificações são criadas sempre que um agendamento é realizado.
\n","_postman_id":"ab4e5a2b-5f40-42d1-bb9b-3676aca51660"},{"name":"Available","item":[{"name":"getList","id":"9e1e354f-673d-442f-aa3a-f739c190a0ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"localhost:3333/providers/3/available?date=1587684718798","description":"Obter lista de horários.
\nParâmetros obrigatórios
\nObter lista de horários disponíveis para agendamento
\n","_postman_id":"b87b4a77-0fae-46d6-9f9c-cecc652499c6"}],"event":[{"listen":"prerequest","script":{"id":"99f2ed65-acef-40be-a5b7-5c25c977f03c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9e01c034-6cc9-47c3-a6fe-920858f27eb5","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseurl","value":"localhost:3333"}]}