Git Product home page Git Product logo

widgets-api's Introduction

Widgets API

API de serviço de widgets e usuarios para ser consumido pelo projeto Widgets SPA.

Tecnologias utilizadas

A API foi produzida usando a linguagem Go, com persistência de dados em MySQL. Foram também usadas as seguintes bibliotecas:

Como executar

Para executar a API é necessário ter um aquivo .env com as credenciais do banco de dados, ou carregar as credenciais em variáveis de sistema. O arquivo .env.example contém exemplo de credenciais.

Variáveis para banco de dados

  • DB_HOST - Host do banco a ser acessado
  • DB_PORT - Porta usada para acessar o banco de dados
  • DB_DATABASE - Banco usado
  • DB_USERNAME - Usuário do banco de dados
  • DB_PASSWORD - Senha do banco de dados
  • DB_AUTO_MIGRATE - Boolean definindo se deve ser realizada a migração das tabelas
  • DB_AUTO_POPULATE - Boolean definindo se deve ser realizada uma população inicial ao crias as tabelas

Executando Nativamente

Para executar a API, basta executar os comandos:

$ go get github.com/guilhermeartem/widgets-api
$ widgets-api

A API pode ser acessada em localhost:4000, e a documentação das rotas em localhost:4000/docs.

Executando com docker-compose

É provido um Dockerfile para geração de uma imagem para Docker e um arquivo docker-compose para facilitar o uso. Para executar desse modo, deve ser feito:

$ git clone github.com/guilhermeartem/widgets-api
$ cd widgets-api
$ docker-compose up

A API pode ser acessada em localhost:4000, e a documentação das rotas em localhost:4000/docs.

##Autenticação

A autenticação é realizada por meio de Json Web Tokens (jwt.io). O JWT é obtido pela chamada à rota /api/login. O cadastro de usuários estava forado escopo desse projeto, assim, foram usadas para teste as credenciais username/password. Para autenticar as chamadas à API, basta adicionar ao header da requisição o campo Authorization, com valor "Bearer token".

widgets-api's People

Contributors

guilhermeartem 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.