{"id":19052320,"url":"https://github.com/michaelcaxias/blogs-api","last_synced_at":"2026-04-29T16:02:04.317Z","repository":{"id":43207404,"uuid":"459359760","full_name":"michaelcaxias/blogs-api","owner":"michaelcaxias","description":"    API Restful de um Blog com NodeJs, Express, Sequelize e JWT     com o banco de dados MySQL     utilizando a estrutura ORM e MSC.","archived":false,"fork":false,"pushed_at":"2022-03-13T19:08:28.000Z","size":2853,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-12T16:24:55.711Z","etag":null,"topics":["api","crud","jwt","msc","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/michaelcaxias.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}},"created_at":"2022-02-14T23:30:09.000Z","updated_at":"2022-04-03T17:49:09.000Z","dependencies_parsed_at":"2022-09-24T08:22:49.549Z","dependency_job_id":null,"html_url":"https://github.com/michaelcaxias/blogs-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/michaelcaxias/blogs-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelcaxias%2Fblogs-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelcaxias%2Fblogs-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelcaxias%2Fblogs-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelcaxias%2Fblogs-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/michaelcaxias","download_url":"https://codeload.github.com/michaelcaxias/blogs-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelcaxias%2Fblogs-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32432917,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-29T13:34:34.882Z","status":"ssl_error","status_checked_at":"2026-04-29T13:34:29.830Z","response_time":110,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["api","crud","jwt","msc","mysql","nodejs","sequelize"],"created_at":"2024-11-08T23:21:54.438Z","updated_at":"2026-04-29T16:02:04.286Z","avatar_url":"https://github.com/michaelcaxias.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"https://khalilstemmler.com/img/blog/sequelize/banner.png\" alt=\"exemplo imagem\" width=\"100px\" align=\"right\"\u003e\n\n# Blogs API\n\nProjeto feito no curso [Trybe](betrybe.com) com objetivo de criar um [CRUD](https://developer.mozilla.org/pt-BR/docs/Glossary/CRUD) a partir da criação de uma API RESTful utilizando as estruturas ORM e MSC.\n\n## ⭐ Habilidades\n\n- Utilizar as habilidades de associação do MySQL.\n- Criar uma API utilizando o Sequelize e NodeJs.\n- Validar e criptografar tokens de autenticação com o [JWT](https://jwt.io/).\n- Realizar validações com o [Joi](https://joi.dev/api/).\n\n\n## 💻 Como iniciar\n\n1. Faça o clone do projeto\n2. Entre no Visual Studio Code\n3. Instale as dependências\n```shell\nnpm install\n```\n4. Inicie a aplicação\n```shell\nnpm run debug\n```\n\n# 💡 Documentação da API\n\n## Cadastra um usuário\n\n```http\n  POST /user\n```\n\n| Corpo da requisição   | Tipo       | Descrição                           |\n| :---------- | :--------- | :---------------------------------- |\n| `displayName, email, password, image` | `json` | **Obrigatório**. Todos os campos do corpo da requisição |\n\n**Formato do corpo da requisição**\n```json\n{\n  \"displayName\": \"Nome da Pessoa\",\n  \"email\": \"emaildapessoa@email.com\",\n  \"password\": \"123456\",\n  \"image\": \"http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/imagem.png\"\n}\n```\n\n**Retorno em caso de sucesso**\n\n```json\n{\n  \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjo1LCJkaXNwbGF5TmFtZSI6InVzdWFyaW8gZGUgdGVzdGUiLCJlbWFpbCI6InRlc3RlQGVtYWlsLmNvbSIsImltYWdlIjoibnVsbCJ9LCJpYXQiOjE2MjAyNDQxODcsImV4cCI6MTYyMDY3NjE4N30.Roc4byj6mYakYqd9LTCozU1hd9k_Vw5IWKGL4hcCVG8\"\n}\n```\n\n\u003e O retorno acima é apenas fictício\n\n\n\n## Retorna todos os usuários\n\n```http\n  GET /user/\n```\n\n**⚠️ Para fazer uma requisição é necessário estar com a chave `Authentication` com o token JWT recebido anteriormente**\n\n**Retorno em caso de sucesso**\n\n```json\n[\n  {\n    \"id\": \"401465483996\",\n    \"displayName\": \"Brett Wiltshire\",\n    \"email\": \"brett@email.com\",\n    \"image\": \"http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png\"\n  }\n]\n```\n\n| Descrição |\n| :--------- |\n| Será retornado um array com todos os usuários do banco de dados |\n\n### Retorna um usuário\n\n```http\n  GET /user/${id}\n```\n\n**⚠️ Para fazer uma requisição é necessário estar com a chave `Authentication` com o token JWT recebido anteriormente**\n\n| Parâmetro   | Tipo       | Descrição                                   |\n| :---------- | :--------- | :------------------------------------------ |\n| `id`      | `string` | **Obrigatório**. O ID do usuário que você quer |\n\n**Retorno em caso de sucesso**\n\n```json\n{\n  \"id\": \"401465483996\",\n  \"displayName\": \"Brett Wiltshire\",\n  \"email\": \"brett@email.com\",\n  \"image\": \"http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png\"\n}\n```\n\n| Descrição |\n| :--------- |\n| Será retornado o usuário com o id especificado |\n\n### Logar de acordo com o banco de dados\n\n```http\n  POST /login\n```\n\n| Corpo da requisição   | Tipo       | Descrição                                   |\n| :---------- | :--------- | :------------------------------------------ |\n| `email, password`      | `json` | **Obrigatório**. Todos os campos do Corpo da requisição devem existir no banco de dados |\n\n**Formato do corpo da requisição**\n\n```json\n{\n  \"email\": \"email@mail.com\",\n  \"password\": \"123456\"\n}\n```\n\n**Retorno em caso de sucesso**\n\n```json\n{\n  \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImlkIjo1LCJkaXNwbGF5TmFtZSI6InVzdWFyaW8gZGUgdGVzdGUiLCJlbWFpbCI6InRlc3RlQGVtYWlsLmNvbSIsImltYWdlIjoibnVsbCJ9LCJpYXQiOjE2MjAyNDQxODcsImV4cCI6MTYyMDY3NjE4N30.Roc4byj6mYakYqd9LTCozU1hd9k_Vw5IWKGL4hcCVG8\"\n}\n```\n\n\u003e O retorno acima é apenas fictício\n\n## Cadastra uma nova categoria\n\n```http\n  POST /categories\n```\n\n| Corpo da requisição   | Tipo       | Descrição                                   |\n| :---------- | :--------- | :------------------------------------------ |\n| `name` | `json` | **Obrigatório**. O nome da categoria deve ser obrigatório |\n\n**⚠️ Para fazer uma requisição é necessário estar com a chave `Authentication` com o token JWT recebido anteriormente**\n\n**Formato do corpo da requisição**\n\n```json\n {\n   \"name\": \"Ação\"\n }\n```\n\n**Retorno em caso de sucesso**\n\n```json\n{\n  \"id\": 1\n  \"name\": \"Ação\"\n}\n```\n\n## Retorna todas as categorias\n\n```http\n  GET /categories\n```\n\n**⚠️ Para fazer uma requisição é necessário estar com a chave `Authentication` com o token JWT recebido anteriormente**\n\n**Retorno em caso de sucesso**\n\n```json\n[\n  {\n    \"id\": 1,\n    \"name\": \"Escola\"\n  },\n  {\n    \"id\": 2,\n    \"name\": \"Inovação\"\n  }\n]\n```\n\n| Descrição |\n| :--------- |\n| Será retornado todas as categorias do Banco de Dados |\n\n### Cadastra uma nova publicação\n\n```http\n  POST /post\n```\n\n| Corpo da requisição   | Tipo       | Descrição                                   |\n| :---------- | :--------- | :------------------------------------------ |\n| `title, content, categoryIds` | json | **Obrigatório**. Todos os campos devem ser obrigatórios |\n\n**⚠️ Para fazer uma requisição é necessário estar com a chave `Authentication` com o token JWT recebido anteriormente**\n\n**Formato do corpo da requisição**\n\n```json\n{\n  \"title\": \"Titulo da publicação\",\n  \"content\": \"Conteudo da publicação aqui\",\n  \"categoryIds\": [1, 2] //id das categorias criadas anteiormente, deve ser somente um array.\n}\n```\n\n**Retorno em caso de sucesso**\n```json\n{\n  \"id\": \"$id da publicação\",\n  \"userId\": 1, // usuário autenticado\n  \"title\": \"Titulo da publicação\",\n  \"content\": \"Conteudo da publicação aqui\"\n}\n```\n\n## Retorna todos as publicações\n\n```http\n  GET /categories\n```\n\n**⚠️ Para fazer uma requisição é necessário estar com a chave `Authentication` com o token JWT recebido anteriormente**\n\n**Retorno em caso de sucesso**\n\n```json\n[\n  {\n    \"id\": 1,\n    \"title\": \"Post do Ano\",\n    \"content\": \"Melhor post do ano\",\n    \"userId\": 1,\n    \"published\": \"2011-08-01T19:58:00.000Z\",\n    \"updated\": \"2011-08-01T19:58:51.000Z\",\n    \"user\": {\n      \"id\": 1,\n      \"displayName\": \"Lewis Hamilton\",\n      \"email\": \"lewishamilton@gmail.com\",\n      \"image\": \"https://upload.wikimedia.org/wikipedia/commons/1/18/Lewis_Hamilton_2017_Malaysia.jpg\"\n    },\n    \"categories\": [\n      {\n        \"id\": 1,\n        \"name\": \"Inovação\"\n      }\n    ]\n  }\n]\n```\n\n| Descrição |\n| :--------- |\n| Será retornado todas as publicações do Banco de Dados, com sua categoria e o autor |\n\n\n\n## Feito Com:\n[![IDE](https://img.shields.io/badge/Visual_studio_code-0078D4?style=for-the-badge\u0026logo=visual%20studio%20code\u0026logoColor=white)](https://code.visualstudio.com/)\n[![NODEJS](https://img.shields.io/badge/Node.js-339933?style=for-the-badge\u0026logo=nodedotjs\u0026logoColor=white)](https://nodejs.org/en/)\n[![SEQUELIZE](https://img.shields.io/badge/Sequelize-52B0E7?style=for-the-badge\u0026logo=Sequelize\u0026logoColor=white)](https://sequelize.org/master/)\n[![MYSQL](https://img.shields.io/badge/MySQL-005C84?style=for-the-badge\u0026logo=mysql\u0026logoColor=white)](https://www.mysql.com/)\n\n\n### Contato\n\n[![Linkedin](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge\u0026logo=linkedin\u0026logoColor=white)](https://www.linkedin.com/in/michaelcaxias/)\n\n\u003cp align=\"center\"\u003eCopyright © 2021 Michael Caxias\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelcaxias%2Fblogs-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichaelcaxias%2Fblogs-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelcaxias%2Fblogs-api/lists"}