Naped-api: A TypeScript repository from Al3xsandro

Naped API 🎥

Tecnologias 🖥️ | Layout 🎨 | Como executar ▶️ | Licença 📖

Tecnologias 🔭

Nestjs
Swagger UI
Typeorm
Jsonwebtoken
Postgres SQL

Docs

Demo: https://naped-project.herokuapp.com/api

Rotas

Swagger

[GET] /api

Usuários 🚀

[POST] /users/create

Criar um novo usuário

 {
   email: "example@example.com",
   username: "example",
   password: "hardpassword"
 }

[POST] /users/auth

Obter token jwt

{
  email: "example@example.com",
  password: "hardpassword"
}

[GET] /users/me

Obter informações do usuário

{
   id: "75659bcc-b2c1-4eae-82f1-788259ae3022",
   email: "example@example.com",
   username: "example",
   isVerified: false,
   isAdmin: false,
   created_at: "2021-09-28T14:26:24.414Z"
}

[GET] /users/{username}

Obter informação de um usuário em especifico

 {
   username: "example",
   created_at: "2021-09-28T14:26:24.414Z"
 }

Notícias 🚀

[GET] /news

Retorna todas as notícias presentes no banco de dados

{
  id: "",
  title: "",
  description: "",
  likes: "",
  views: "", 
  thumbnail: "",
  categorie: "",
  created_at: ""
}

[POST] /news/create

Criar nova notícia

 {
   title: "",
   description: "",
   thumbnail: "",
   categorie: ""
 }

[PUT] /news/like

Favoritar noticia
```
 {
    "likes": 1
 }
```

Iniciando a aplicação

# development
$ yarn start

# watch mode
$ yarn start:dev

# production mode
$ yarn start:prod

# tests 
$ yarn test

License