Skip to content

wrsilva/api_flask_python

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API Pessoa / API Person

  • Este projeto, chamado "API Pessoa", é uma API em Python desenvolvida utilizando Flask, Swagger e MySQL. Ela foca em lidar com operações CRUD (INSERT, UPDATE, DELETE) para gerenciar dados relacionados a pessoas.
  • This project, named "API Pessoa," is a Python-based API developed using Flask, Swagger, and MySQL. It focuses on handling CRUD operations (INSERT, UPDATE, DELETE) for managing person-related data.

Funcionalidades Principais / Key Features

  • Operações INSERT, UPDATE, DELETE, GET: A API permite o gerenciamento de dados relacionados a pessoas com essas funcionalidades principais.
  • INSERT, UPDATE, DELETE operations: The API allows for the management of person-related data with these key functionalities.

Tecnologias Utilizadas / Technologies Used

  • Python:
    • A linguagem de programação principal utilizada neste projeto.
    • The primary programming language used in this project.
  • Flask:
    • Um framework web leve para Python.
    • A lightweight web framework for Python.
  • Swagger:
    • Uma ferramenta para documentação e teste de APIs.
    • A tool for API documentation and testing.
  • MySQL:
    • Sistema de gerenciamento de banco de dados relacional.
    • Relational database management system.

Variáveis de Ambiente / Environment Variables

  • As variáveis de ambiente estão configuradas no arquivo server/instance.py.
  • The environment variables are configured in the server/instance.py file.

Configuração / Setup

  1. Criar Ambiente Virtual / Create Virtual Environment:
    • Execute o comando python -m venv venv para criar um ambiente virtual.
    • Run the command python -m venv venv to create a virtual environment.
  2. Ativar Ambiente Virtual / Activate Virtual Environment:
    • Ative o ambiente virtual com o comando source venv/bin/activate.
    • Activate the virtual environment using the command source venv/bin/activate
  3. Instalar Dependências / Install Dependencies:
    • Execute pip install -r src/requirements.txt para instalar as dependências necessárias.
    • Run pip install -r src/requirements.txt to install the necessary dependencies.
  4. Iniciar o Servidor / Start the Server:
    • Execute python3 src/app_dev.py para iniciar o servidor.
    • Run python src/app_dev.py to start the server.

Acesso à Documentação / Accessing Documentation

Contribuição / Contribution

  • Contribuições são bem-vindas! Sinta-se à vontade para abrir issues e pull requests.
  • Contributions are welcome! Feel free to open issues and pull requests.

Licença / License

  • Este projeto é distribuído sob uma licença de código aberto. Veja o arquivo LICENSE para mais detalhes.
  • This project is distributed under an open-source license. See the LICENSE file for more details.

Releases

No releases published

Packages

No packages published