Skip to content
/ users Public

A simple CRUD API made with flask and mongodb

Notifications You must be signed in to change notification settings

heronrs/users

Repository files navigation

Users API

Simples API CRUD para cadastro de usuários

Desenvolvida em python, utilizando flask e extensões

A aplicação suporta o inject de variáveis de ambiente através de um arquivo .env no root do projeto.

Variáveis de ambiente necessárias:

    FLASK_ENV(obrigatório) - Ambiente (development, production, staging, etc)
    FLASK_APP(obrigatório) - Nome do app ("api")
    FLASK_DEBUG(obrigatório) - 1 ou 0
    MONGODB_URI(brigatório) - Mongo conexion string na forma "mongodb://user:pass@db:27017/api"
    SECRET_KEY(obrigatório) - String utilizada internamente pelo Flask p/ controle de sessão, csrf, etc
    LOG_LEVEL(opcional) - Nível do Log, default INFO
  • Documentação: API Blueprint, Html, Postman

  • Requisitos para rodar local: Docker, Docker Compose e Python 3.6 + para desenvolvimento

  • Iniciar ambiente local:

      $/users: sudo docker-compose up --build -d
      $/users: firefox localhost:8000/api/v1/users
    
  • Rodar os testes:

      $/users: sudo docker-compose run api sh -c "find -name '*.pyc' -delete && pytest -v"
    

About

A simple CRUD API made with flask and mongodb

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published