{"id":21309949,"url":"https://github.com/joaoespacheco/trybe-project-26-blogs-api","last_synced_at":"2026-04-15T19:32:48.100Z","repository":{"id":119703457,"uuid":"573949005","full_name":"joaoespacheco/Trybe-Project-26-blogs-api","owner":"joaoespacheco","description":"API RESTful que gerencia a criação, modificação, leitura e exclusão de conteúdos para um blog no banco de dados","archived":false,"fork":false,"pushed_at":"2023-01-13T02:22:07.000Z","size":533,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-22T09:33:13.102Z","etag":null,"topics":["docker","expressjs","javascript","joi-validation","json-web-token","mysql","nodejs","sequelize"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joaoespacheco.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-03T23:46:15.000Z","updated_at":"2024-12-20T17:07:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"d4b7f56d-7bf0-4d0b-93a7-d6ff5eaa7dce","html_url":"https://github.com/joaoespacheco/Trybe-Project-26-blogs-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joaoespacheco%2FTrybe-Project-26-blogs-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joaoespacheco%2FTrybe-Project-26-blogs-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joaoespacheco%2FTrybe-Project-26-blogs-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joaoespacheco%2FTrybe-Project-26-blogs-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joaoespacheco","download_url":"https://codeload.github.com/joaoespacheco/Trybe-Project-26-blogs-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243787982,"owners_count":20347958,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","expressjs","javascript","joi-validation","json-web-token","mysql","nodejs","sequelize"],"created_at":"2024-11-21T17:11:34.256Z","updated_at":"2026-04-15T19:32:48.048Z","avatar_url":"https://github.com/joaoespacheco.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Blogs API 💻\n\n## 📄 Sobre:\n\nProjeto desenvolvido durante o módulo de back-end do curso de desenvolvimento web da [Trybe](https://www.betrybe.com/).\n\nNeste projeto foi desenvolvida uma API RESTful e um banco de dados para a produção de conteúdo de um blog.\n\nPara está aplicação foi utilizado o banco de dados \u003cstrong\u003eMySQL\u003c/strong\u003e e o \u003cstrong\u003eORM sequelize\u003c/strong\u003e.\n\nA API foi criada utilizando arquitetura \u003cstrong\u003eMSC (model-service-controller)\u003c/strong\u003e.\n\nPara as funções de autenticação foi utilizado a ferramenta \u003cstrong\u003eJSON Web Token\u003c/strong\u003e.\n\n\n\u003c/br\u003e\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eDesempenho\u003c/strong\u003e\u003c/summary\u003e\nAprovado com 100% de desempenho em todos os requisitos\n\n![image](https://user-images.githubusercontent.com/99846604/212220238-367948e8-a802-4424-9c88-8ca8cb090f21.png)\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eRequisitos\u003c/strong\u003e\u003c/summary\u003e\n\u003c/br\u003e\n\u003cstrong\u003eRequisitos obrigatórios:\u003c/strong\u003e \u003c/br\u003e\n\n1. Crie migrations para as tabelas users, categories, blog_posts, posts_categories \u003c/br\u003e\n2. Crie o modelo User em src/models/User.js com as propriedades corretas \u003c/br\u003e\n3. Crie o endpoint POST /login, suas funcionalidades e validações necessárias \u003c/br\u003e\n4. Crie o endpoint POST /user, suas funcionalidades e validações necessárias \u003c/br\u003e\n5. Crie o endpoint GET /user, suas funcionalidades e validações necessárias \u003c/br\u003e\n6. Crie o endpoint GET /user/:id, suas funcionalidades e validações necessárias \u003c/br\u003e\n7. Crie o modelo Category em src/models/Category.js com as propriedades corretas \u003c/br\u003e\n8. Crie o endpoint POST /categories, suas funcionalidades e validações necessárias \u003c/br\u003e\n9. Crie o endpoint GET /categories, suas funcionalidades e validações necessárias \u003c/br\u003e\n10. Crie o modelo BlogPost em src/models/BlogPost.js com as propriedades e associações corretas \u003c/br\u003e\n11. Crie o modelo PostCategory em src/models/PostCategory.js com as propriedades e associações corretas \u003c/br\u003e\n12. Crie o endpoint POST /post, suas funcionalidades e validações necessárias \u003c/br\u003e\n13. Crie o endpoint GET /post, suas funcionalidades e validações necessárias \u003c/br\u003e\n14. Crie o endpoint GET /post/:id, suas funcionalidades e validações necessárias \u003c/br\u003e\n15. Crie o endpoint PUT /post/:id, suas funcionalidades e validações necessárias \u003c/br\u003e\n\u003c/br\u003e\n\n\u003cstrong\u003eRequisitos bônus:\u003c/strong\u003e \u003c/br\u003e\n16. Crie o endpoint DELETE /post/:id, suas funcionalidades e validações necessárias \u003c/br\u003e\n17. Crie o endpoint DELETE /user/me, suas funcionalidades e validações necessárias \u003c/br\u003e\n18. Crie o endpoint GET /post/search?q=:searchTerm, suas funcionalidades e validações necessárias \u003c/br\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eDiagrama Entidade-Relacionamento\u003c/strong\u003e\u003c/summary\u003e\n \n![image](https://user-images.githubusercontent.com/99846604/209252421-d2ec9654-de1f-4a72-b851-e1a4647f21f5.png)\n \n\u003c/details\u003e\n\u003c/br\u003e\n\n## ⚙️ Execução\n\nPara executar a aplicação inicie realizando o clone deste repositório com o comando abaixo.\n\n      git clone git@github.com:joaoespacheco/Trybe-Project.26-blogs-api.git\n\nNavegue até a raíz do projeto.\n\n      cd Trybe-Project.26-blogs-api/\n      \nUma vez na raiz do projeto, execute o comando abaixo para instalar as dependências do projeto.\n    \n    npm install\n\u003cbr/\u003e\n\n\u003cdetails\u003e\n   \u003csummary\u003e\u003cstrong\u003eRodando a aplicação com o Docker\u003c/strong\u003e\u003c/summary\u003e\n  \u003c/br\u003e\n\n   Na pasta raiz do projeto, suba o container através do docker-compose.yml, utilizando o comando abaixo.\n\n        docker-compose up -d\n\n   Entre no terminal do container\n\n        docker exec -it blogs_api bash\n        \n   Caso não tenha instalado anteriormente, uma vez no terminal do container, execute o comando abaixo para instalar as dependências do projeto.\n\n        npm install\n        \n   Para criar o banco e executar as migrations utilize o seguinte comando no terminal do container\n   \n        npm run prestart\n\n   Para popular o banco criado utilize o seguinte comando no terminal do container\n   \n        npm run seed\n        \n   Para iniciar o servidor utilize o seguinte comando no terminal do container\n\n        npm run start\n        \n   Para iniciar o servidor no modo de desenvolvimento utilize o seguinte comando no terminal do container\n\n        npm run debug\n\n   Para dropar o banco criado utilize o seguinte comando no terminal do container\n   \n        npm run drop\n\n\u003c/details\u003e\n\u003c/br\u003e\n\n## ↪️ Rotas:\n\nA documentação referente as rotas foi confeccionada utilizando a ferramenta Swagger/OpenAPI e pode ser visualizada de duas maneiras:\n\n### Acessando as informações das rotas localmente:\nA documentação das rotas pode ser acessada após iniciar a aplicação localmente de acordo com as instruções da seção anterior chamada \"Execução\". \u003c/br\u003e \n\u003c/br\u003e\nPara visualizar as rotas e testar as requisições você pode utilizar a rota http://localhost:3000/api-docs. Caso preferir, você também pode utilizar um cliente de requisições HTTP de sua preferência (Insomnia, Thunder Client, etc) para realizar os testes.\n\n### Acessando as informações das rotas online:\nPara visualizar as rotas você pode utilizar a plataforma Swagger Viewer \u003cstrong\u003e[clicando aqui](https://swaggerviewer.ptr.red/spec/aHR0cHM6Ly9naXRodWIuY29tL2pvYW9lc3BhY2hlY28vVHJ5YmUtUHJvamVjdC4yNi1ibG9ncy1hcGkvcmF3L21haW4vc3JjL3N3YWdnZXIuanNvbg%3D%3D)\u003c/strong\u003e.\n      \n\u003c/br\u003e\n\n## 🤹🏽 Habilidades Desenvolvidas:\n* Criar uma aplicação utilizando Express.js\n* Criar uma API RESTful utilizando arquitetura MSC (Model-Service-Controller)\n* Validar os dados das requisições utilizando a biblioteca Joi\n* Criar um banco de dados, suas migrations, models e associações entre as tabelas\n* Utilizar ORM Sequelize para realizar as conexões e as queries ao banco de dados\n* Implementar autenticação via token utilizando JSON Web Token\n\u003c/br\u003e\n\n## 🧰 Ferramentas:\n* JavaScript\n* Node.js\n  * Express.js\n* DotEnv\n* Joi\n* MySQL\n* Sequelize\n* JSON Web Token\n* Docker\n* Swagger\n\u003c/br\u003e\n\n## 📝 Desenvolvido por:\n* [João Emanuel Soares Pacheco](https://github.com/joaoespacheco)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoaoespacheco%2Ftrybe-project-26-blogs-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoaoespacheco%2Ftrybe-project-26-blogs-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoaoespacheco%2Ftrybe-project-26-blogs-api/lists"}