https://github.com/wladiveras/phoenix-api

RESTful API
https://github.com/wladiveras/phoenix-api

api api-rest boilerplate node-api nodejs nodejs-server typescript

Last synced: 9 months ago
JSON representation

RESTful API

• Host: GitHub
• URL: https://github.com/wladiveras/phoenix-api
• Owner: wladiveras
• Created: 2021-12-28T19:33:53.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-04-01T13:04:55.000Z (over 3 years ago)
• Last Synced: 2025-02-06T23:41:22.435Z (11 months ago)
• Topics: api, api-rest, boilerplate, node-api, nodejs, nodejs-server, typescript
• Language: TypeScript
• Homepage: https://wladiveras.com
• Size: 599 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Phoenix API Boilerplate // MongoDB // JWT

[![forthebadge](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMDIuMjY5OTk5OTk5OTk5OTgiIGhlaWdodD0iMzUiIHZpZXdCb3g9IjAgMCAyMDIuMjY5OTk5OTk5OTk5OTggMzUiPjxyZWN0IGNsYXNzPSJzdmdfX3JlY3QiIHg9IjAiIHk9IjAiIHdpZHRoPSI5NS42IiBoZWlnaHQ9IjM1IiBmaWxsPSIjMzFDNEYzIi8+PHJlY3QgY2xhc3M9InN2Z19fcmVjdCIgeD0iOTMuNiIgeT0iMCIgd2lkdGg9IjEwOC42Njk5OTk5OTk5OTk5OSIgaGVpZ2h0PSIzNSIgZmlsbD0iIzM4OUFENSIvPjxwYXRoIGNsYXNzPSJzdmdfX3RleHQiIGQ9Ik0xNS43MCAyMkwxNC4yMiAyMkwxNC4yMiAxMy40N0wxNy40OCAxMy40N1ExOC45MSAxMy40NyAxOS43NSAxNC4yMVEyMC41OSAxNC45NiAyMC41OSAxNi4xOEwyMC41OSAxNi4xOFEyMC41OSAxNy40NCAxOS43NyAxOC4xM1ExOC45NSAxOC44MyAxNy40NiAxOC44M0wxNy40NiAxOC44M0wxNS43MCAxOC44M0wxNS43MCAyMlpNMTUuNzAgMTQuNjZMMTUuNzAgMTcuNjRMMTcuNDggMTcuNjRRMTguMjcgMTcuNjQgMTguNjkgMTcuMjdRMTkuMTAgMTYuOTAgMTkuMTAgMTYuMTlMMTkuMTAgMTYuMTlRMTkuMTAgMTUuNTAgMTguNjggMTUuMDlRMTguMjYgMTQuNjggMTcuNTIgMTQuNjZMMTcuNTIgMTQuNjZMMTUuNzAgMTQuNjZaTTI2LjM2IDIyTDI0Ljg4IDIyTDI0Ljg4IDEzLjQ3TDI2LjM2IDEzLjQ3TDI2LjM2IDE3LjAyTDMwLjE3IDE3LjAyTDMwLjE3IDEzLjQ3TDMxLjY1IDEzLjQ3TDMxLjY1IDIyTDMwLjE3IDIyTDMwLjE3IDE4LjIxTDI2LjM2IDE4LjIxTDI2LjM2IDIyWk0zNi4xMiAxOC4wMEwzNi4xMiAxOC4wMEwzNi4xMiAxNy41MlEzNi4xMiAxNi4yOCAzNi41NiAxNS4zMlEzNy4wMCAxNC4zNyAzNy44MSAxMy44NlEzOC42MiAxMy4zNSAzOS42NiAxMy4zNVE0MC43MCAxMy4zNSA0MS41MSAxMy44NVE0Mi4zMSAxNC4zNSA0Mi43NSAxNS4yOVE0My4xOSAxNi4yMyA0My4yMCAxNy40OEw0My4yMCAxNy40OEw0My4yMCAxNy45NlE0My4yMCAxOS4yMSA0Mi43NiAyMC4xNlE0Mi4zMyAyMS4xMCA0MS41MiAyMS42MVE0MC43MiAyMi4xMiAzOS42NyAyMi4xMkwzOS42NyAyMi4xMlEzOC42MyAyMi4xMiAzNy44MiAyMS42MVEzNy4wMSAyMS4xMCAzNi41NyAyMC4xN1EzNi4xMyAxOS4yMyAzNi4xMiAxOC4wMFpNMzcuNjAgMTcuNDZMMzcuNjAgMTcuOTZRMzcuNjAgMTkuMzYgMzguMTUgMjAuMTNRMzguNzAgMjAuOTAgMzkuNjcgMjAuOTBMMzkuNjcgMjAuOTBRNDAuNjUgMjAuOTAgNDEuMTggMjAuMTVRNDEuNzIgMTkuNDAgNDEuNzIgMTcuOTZMNDEuNzIgMTcuOTZMNDEuNzIgMTcuNTFRNDEuNzIgMTYuMDkgNDEuMTggMTUuMzRRNDAuNjQgMTQuNTggMzkuNjYgMTQuNThMMzkuNjYgMTQuNThRMzguNzAgMTQuNTggMzguMTYgMTUuMzNRMzcuNjEgMTYuMDkgMzcuNjAgMTcuNDZMMzcuNjAgMTcuNDZaTTUzLjI0IDIyTDQ3LjY2IDIyTDQ3LjY2IDEzLjQ3TDUzLjIwIDEzLjQ3TDUzLjIwIDE0LjY2TDQ5LjE0IDE0LjY2TDQ5LjE0IDE3LjAyTDUyLjY1IDE3LjAyTDUyLjY1IDE4LjE5TDQ5LjE0IDE4LjE5TDQ5LjE0IDIwLjgyTDUzLjI0IDIwLjgyTDUzLjI0IDIyWk01OC45MiAyMkw1Ny40NCAyMkw1Ny40NCAxMy40N0w1OC45MiAxMy40N0w2Mi43MyAxOS41NEw2Mi43MyAxMy40N0w2NC4yMCAxMy40N0w2NC4yMCAyMkw2Mi43MiAyMkw1OC45MiAxNS45NUw1OC45MiAyMlpNNzAuNTEgMjJMNjkuMDMgMjJMNjkuMDMgMTMuNDdMNzAuNTEgMTMuNDdMNzAuNTEgMjJaTTc2LjQxIDIyTDc0LjY5IDIyTDc3LjMzIDE3LjcwTDc0Ljc1IDEzLjQ3TDc2LjQ2IDEzLjQ3TDc4LjI1IDE2LjU1TDgwLjA1IDEzLjQ3TDgxLjc2IDEzLjQ3TDc5LjE4IDE3LjcwTDgxLjgyIDIyTDgwLjA5IDIyTDc4LjI1IDE4Ljg3TDc2LjQxIDIyWiIgZmlsbD0iI0ZGRkZGRiIvPjxwYXRoIGNsYXNzPSJzdmdfX3RleHQiIGQ9Ik0xMDkuMjEgMjJMMTA2Ljc4IDIyTDExMC40OSAxMy42MEwxMTIuODMgMTMuNjBMMTE2LjU1IDIyTDExNC4wOCAyMkwxMTMuNDIgMjAuMzdMMTA5Ljg3IDIwLjM3TDEwOS4yMSAyMlpNMTExLjY0IDE1LjkzTDExMC41NiAxOC42MUwxMTIuNzIgMTguNjFMMTExLjY0IDE1LjkzWk0xMjMuMDggMjJMMTIwLjcwIDIyTDEyMC43MCAxMy42MEwxMjQuNTUgMTMuNjBRMTI1LjY4IDEzLjYwIDEyNi41MiAxMy45OFExMjcuMzYgMTQuMzUgMTI3LjgyIDE1LjA2UTEyOC4yOCAxNS43NiAxMjguMjggMTYuNzFMMTI4LjI4IDE2LjcxUTEyOC4yOCAxNy42NiAxMjcuODIgMTguMzVRMTI3LjM2IDE5LjA1IDEyNi41MiAxOS40MlExMjUuNjggMTkuODAgMTI0LjU1IDE5LjgwTDEyNC41NSAxOS44MEwxMjMuMDggMTkuODBMMTIzLjA4IDIyWk0xMjMuMDggMTUuNDdMMTIzLjA4IDE3LjkzTDEyNC40MCAxNy45M1ExMjUuMTMgMTcuOTMgMTI1LjUwIDE3LjYxUTEyNS44OCAxNy4yOSAxMjUuODggMTYuNzFMMTI1Ljg4IDE2LjcxUTEyNS44OCAxNi4xMiAxMjUuNTAgMTUuODBRMTI1LjEzIDE1LjQ3IDEyNC40MCAxNS40N0wxMjQuNDAgMTUuNDdMMTIzLjA4IDE1LjQ3Wk0xMzUuNDEgMjJMMTMzLjAzIDIyTDEzMy4wMyAxMy42MEwxMzUuNDEgMTMuNjBMMTM1LjQxIDIyWk0xNDkuOTMgMjJMMTQ3LjU2IDIyTDE0Ny41NiAxMy42MEwxNTEuNDAgMTMuNjBRMTUyLjU0IDEzLjYwIDE1My4zOCAxMy45OFExNTQuMjIgMTQuMzUgMTU0LjY3IDE1LjA2UTE1NS4xMyAxNS43NiAxNTUuMTMgMTYuNzFMMTU1LjEzIDE2LjcxUTE1NS4xMyAxNy42MiAxNTQuNzAgMTguMzBRMTU0LjI4IDE4Ljk4IDE1My40OSAxOS4zNkwxNTMuNDkgMTkuMzZMMTU1LjMwIDIyTDE1Mi43NSAyMkwxNTEuMjMgMTkuNzdMMTQ5LjkzIDE5Ljc3TDE0OS45MyAyMlpNMTQ5LjkzIDE1LjQ3TDE0OS45MyAxNy45M0wxNTEuMjUgMTcuOTNRMTUxLjk5IDE3LjkzIDE1Mi4zNiAxNy42MVExNTIuNzMgMTcuMjkgMTUyLjczIDE2LjcxTDE1Mi43MyAxNi43MVExNTIuNzMgMTYuMTIgMTUyLjM2IDE1Ljc5UTE1MS45OSAxNS40NyAxNTEuMjUgMTUuNDdMMTUxLjI1IDE1LjQ3TDE0OS45MyAxNS40N1pNMTY2LjY2IDIyTDE1OS45MiAyMkwxNTkuOTIgMTMuNjBMMTY2LjUxIDEzLjYwTDE2Ni41MSAxNS40NEwxNjIuMjcgMTUuNDRMMTYyLjI3IDE2Ljg1TDE2Ni4wMSAxNi44NUwxNjYuMDEgMTguNjNMMTYyLjI3IDE4LjYzTDE2Mi4yNyAyMC4xN0wxNjYuNjYgMjAuMTdMMTY2LjY2IDIyWk0xNzAuODggMjEuMjRMMTcwLjg4IDIxLjI0TDE3MS42NiAxOS40OVExNzIuMjIgMTkuODYgMTcyLjk3IDIwLjA5UTE3My43MSAyMC4zMiAxNzQuNDMgMjAuMzJMMTc0LjQzIDIwLjMyUTE3NS44MCAyMC4zMiAxNzUuODAgMTkuNjRMMTc1LjgwIDE5LjY0UTE3NS44MCAxOS4yOCAxNzUuNDEgMTkuMTFRMTc1LjAyIDE4LjkzIDE3NC4xNiAxOC43NEwxNzQuMTYgMTguNzRRMTczLjIxIDE4LjUzIDE3Mi41NyAxOC4zMFExNzEuOTQgMTguMDYgMTcxLjQ4IDE3LjU1UTE3MS4wMyAxNy4wMyAxNzEuMDMgMTYuMTZMMTcxLjAzIDE2LjE2UTE3MS4wMyAxNS4zOSAxNzEuNDUgMTQuNzdRMTcxLjg3IDE0LjE1IDE3Mi43MCAxMy43OVExNzMuNTQgMTMuNDMgMTc0Ljc0IDEzLjQzTDE3NC43NCAxMy40M1ExNzUuNTcgMTMuNDMgMTc2LjM3IDEzLjYyUTE3Ny4xOCAxMy44MCAxNzcuODAgMTQuMTdMMTc3LjgwIDE0LjE3TDE3Ny4wNiAxNS45M1ExNzUuODYgMTUuMjggMTc0LjczIDE1LjI4TDE3NC43MyAxNS4yOFExNzQuMDIgMTUuMjggMTczLjcwIDE1LjQ5UTE3My4zOCAxNS43MCAxNzMuMzggMTYuMDRMMTczLjM4IDE2LjA0UTE3My4zOCAxNi4zNyAxNzMuNzYgMTYuNTRRMTc0LjE1IDE2LjcxIDE3NC45OSAxNi44OUwxNzQuOTkgMTYuODlRMTc1Ljk2IDE3LjEwIDE3Ni41OSAxNy4zM1ExNzcuMjIgMTcuNTYgMTc3LjY4IDE4LjA3UTE3OC4xNCAxOC41OCAxNzguMTQgMTkuNDZMMTc4LjE0IDE5LjQ2UTE3OC4xNCAyMC4yMSAxNzcuNzIgMjAuODNRMTc3LjMwIDIxLjQ0IDE3Ni40NiAyMS44MFExNzUuNjIgMjIuMTcgMTc0LjQyIDIyLjE3TDE3NC40MiAyMi4xN1ExNzMuNDAgMjIuMTcgMTcyLjQ0IDIxLjkyUTE3MS40OCAyMS42NyAxNzAuODggMjEuMjRaTTE4NC41MSAxNS40OEwxODEuOTMgMTUuNDhMMTgxLjkzIDEzLjYwTDE4OS40NSAxMy42MEwxODkuNDUgMTUuNDhMMTg2Ljg4IDE1LjQ4TDE4Ni44OCAyMkwxODQuNTEgMjJMMTg0LjUxIDE1LjQ4WiIgZmlsbD0iI0ZGRkZGRiIgeD0iMTA2LjYiLz48L3N2Zz4=)](https://wladiveras.com)

[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://wladiveras.com)\

  Node.js REST API com Autenticação para seu projeto.\

  \

  *Antes de iniciar o projeto renomeio o arquivo default.example.ts para default.ts e configure conforme sua necessidade.*

## Rotas

### > Autenticação

  

  **{POST}** - /auth/login\

  **{POST}** - /auth/register\

  **{GET}**  - /auth/token\

  **{POST}** - /auth/logout

#### > Users (CRUD)

  **{GET}** - /users/{userID}\

  **{GET}** - /users/{userID}/posts\

#### > Posts (CRUD)

  **{POST}** - /posts\

  **{GET}** - /posts\

  **{PATCH}** - /posts/{postID}\

  **{GET}** - /posts/{postID}\

  **{DELETE}** - /posts/{postID}

  

## A fazer

- [x] module ::Refresh Token

- [ ] docs :: Finalizar markdown