Code Monkey home page Code Monkey logo

blog-api's Introduction

Blog API

Este projeto teve o objetivo de desenvolver uma API para um blog utilizando as seguintes tecnologias:

  • Sequelize
  • Nodejs
  • Docker
  • JWT para controle de acesso.

Para executar localmente, clone o repositório e execute os seguintes comandos:

$ docker-compose up -d
$ docker exec -it store_manager bash
$ npm run seed
$ npm start

Metodo de login

Methodo Rota Descrição
post /login Retorna um token de acesso

Formato de requisição para o POST:

{
	"email":"[email protected]",
	"password":"123456"
}

Metodos de usuário

Methodo Rota Descrição
get /user Retorna todos os usuários cadastrados
get /user/id Retorna um usuário cadastrado com base no id informado
post /user Cadastra um novo usuário
delete /user/me Apaga usuário logado na sessão

Formato de requisição para o POST e PUT:

{
  "displayName": "Brett Wilsdtshire",
  "email": "[email protected]",
  "password": "123456",
  "image": "http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png"
}

Metodos de um blogPost

Methodo Rota Descrição
get /post Retorna todos os posts feitos pelo usuário logado
get /post/search?q= Retorna os posts que contenham a palavra pesquisada
get /post/:id Retorna um único post a partir do id
post /post Cria um novo post
put /post/:id Edita um post a partir do id
delete /post/:id Apaga um post a partir do id

Formato de requisição para o POST e PUT:

{
  "title": "New post",
  "content": "The whole text for the blog post goes here in this key",
	"categories":[1,2]
}

Metodos de uma categoria

Methodo Rota Descrição
get /categories Retorna todas as categorias cadastradas
post /categories Cria uma nova categoria para os posts

Formato de requisição para o POST:

{
  "name": "Typescript"
}

blog-api's People

Contributors

italoo13 avatar trybe-tech-ops avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.