Loading repository data…
Lucasbrunoferreira / repository
📡 A simple example to implements a http web service with python, flask framework, docker, mongo and marshmallow schemas.
A transparent discovery signal based on current public GitHub metadata.
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
This is a simple example, to implements a http web server (API RESTfull) with python (Flask framework).
| Dependency | For what? | Link |
|---|---|---|
| flask | web framework server | http://flask.pocoo.org |
| flask-restful | extension for Flask that adds support for quickly building REST APIs | https://flask-restful.readthedocs.io |
| pymongo | mongo database driver | https://api.mongodb.com/python/current/ |
| marshmallow | fileds schema validator | https://marshmallow.readthedocs.io |
| logzero | create application logs | https://logzero.readthedocs.io/en/latest/ |
| unittest | unit tests | https://docs.python.org/3/library/unittest.html |
/api/v1/pets - Get all pets/api/v1/pets/{pet_id} - Get only the pet for the id entered in the parameter/api/v1/pets - Create new pet/api/v1/pets/{pet_id} - Edit the pet referring to the id entered in the parameter/api/v1/pets/{pet_id} - Delete the pet referring to the id entered in the parameterControllers - It is the layer responsible for manipulating requests and performing business rules.
Persistence - Layer responsible for data manipulation.
Selected from shared topics, language and repository description—not editorial ratings.
charmibandapalli /
A web-based URL shortener that generates short URLs and redirects users to the original links. Tech Stack: Python, Flask, Random Features: 🔗 Shortens long URLs 🚀 Quick redirection 📡 Simple API-based architecture
27/100 healthSchemas - Data modeling.
Database - Connection and manipulation with database.
Tests - Layer with unit application tests
Util - Gathers higher-use (repetitive) codes in the project.
Run all unit application tests
cd project-folderpython -m unittestAfter preparing your environment and your virtualenv, follow the steps:
cd project-folderpip install -r requirements.txtpython server.pyRun application with docker:
cd project-folderdocker build -t api-flask-img .docker run -d -p 8080:8080 --name api-flask -e MONGO_URI="mongodb://user:password@host:port/database" api-flask-img:latestEste é um exemplo simples, para implementar um servidor web http (API RESTfull) com python (framework Flask).
| Dependência | Qual o uso? | Link |
|---|---|---|
| flask | framework para servidor web | http://flask.pocoo.org |
| flask-restful | extensão para adicionar construir REST APIs no Flask com mais praticidade. | https://flask-restful.readthedocs.io |
| pymongo | conexão com o banco de dado NoSQL mongo | https://api.mongodb.com/python/current/ |
| marshmallow | validação de campos e dados | https://marshmallow.readthedocs.io |
| logzero | criação de logs da applicação | https://logzero.readthedocs.io/en/latest/ |
| unittest | testes unitários | https://docs.python.org/3/library/unittest.html |
/api/v1/pets - Buscar todos os pets cadastrados/api/v1/pets/{pet_id} - Busque apenas o pet referente ao id informado no paramêtro/api/v1/pets - Criar um novo pet/api/v1/pets/{pet_id} - Editar o pet referente ao id informado no parâmetro/api/v1/pets/{pet_id} - Deletar o pet referente ao id informado no parâmetroController - É a camada responsável por manipular as requisições e realizar as regras de negócios.
Persistence - Camada responsável pela manipulação de dados.
Schemas - Modelagem de dados.
Database - Conexão e manipulação com banco de dados.
Tests - Camada com os testes unitarios da aplicação
Util - Reúne códigos de uso mais alto (repetitivos) no projeto
Para realizar todos os testes do projeto, execute:
cd project-folderpython -m unittestDepois de preparar seu ambiente e seu virtualenv, siga os passos:
cd project-folderpip install -r requirements.txtpython main.pySe preferir, pode executar a aplicação com o docker:
cd project-folderdocker build -t api-flask-img .docker run -d -p 8080:8080 --name api-flask -e MONGO_URI="mongodb://user:password@host:port/database" api-flask-img:latest