https://github.com/gemaquejr/python-crossfit-api

Projeto que visa desenvolver uma API de poucas tabelas, mas com o necessário para aprender como utilizar o FastAPI.
https://github.com/gemaquejr/python-crossfit-api

alembic fastapi pydantic python sqlalchemy

Last synced: 8 days ago
JSON representation

Projeto que visa desenvolver uma API de poucas tabelas, mas com o necessário para aprender como utilizar o FastAPI.

• Host: GitHub
• URL: https://github.com/gemaquejr/python-crossfit-api
• Owner: gemaquejr
• License: mit
• Created: 2024-07-09T21:24:25.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-11T22:12:27.000Z (4 months ago)
• Last Synced: 2024-07-12T02:34:32.122Z (4 months ago)
• Topics: alembic, fastapi, pydantic, python, sqlalchemy
• Language: Python
• Homepage:
• Size: 33.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Crossfit API

Esta é a API do projeto Crossfit, construída utilizando FastAPI. A API permite a criação, consulta, atualização e deleção de atletas, categorias e centros de treinamento.

## 🚀 Tecnologia

- ⚡ Python é uma linguagem de programação de alto nível, interpretada de script, imperativa, orientada a objetos, funcional, de tipagem dinâmica e forte.

- ⚡ FastAPI é uma estrutura web moderna para construir APIs RESTful em Python.

- ⚡ Pydantic é uma biblioteca Python para executar a validação de dados.

- ⚡ SQLAlchemy é uma biblioteca de mapeamento objeto-relacional SQL em código aberto desenvolvido para a linguagem de programação Python.

- ⚡ Uvicorn é um servidor ASGI peso leve, construído com uvloop e httptools. Ele não é um framework web, mas sim um servidor.

## ✋🏻 Pré-requisitos

- [git](https://git-scm.com/downloads): Ferramenta para gerenciar o código-fonte

- [Visual Studio Code](https://code.visualstudio.com/): Editor de Código Fonte

- [Python](https://www.python.org/): linguagem de programação de alto nível, interpretada de script, imperativa, orientada a objetos, funcional, de tipagem dinâmica e forte.

## :hammer_and_wrench: Antes de iniciar o projeto.

Crie e ative um ambiente virtual:

### `python3 -m venv venv`

### `source venv/bin/activate`

Instale as dependências:

### `pip install -r requirements.txt`

Execute a aplicação:

### `make run`

## Documentação da API

A documentação completa da API está disponível em Swagger UI.