FastAPI Template

Modelo FASTAPI

Descrição

O modelo FASTAPI é um modelo de projeto que fornece uma boa estrutura de arquivo e configuração para criar aplicativos FASTAPI. Ele inclui um ambiente de desenvolvimento pré-configurado, scripts de implantação prontos para produção e opções de configuração SSL. Este modelo tem como objetivo facilitar o início dos desenvolvedores de novos projetos FASTAPI com uma base robusta e práticas recomendadas em mente.

Características

• Limpe a estrutura do arquivo para organizar seu aplicativo FASTAPI
• Configuração do ambiente virtual para dependências isoladas
• Scripts de bash prontos para produção para implantação
• Configuração configurável SSL para conexões seguras
• O registro pré-configurado com logs salvos em um arquivo
• UI da web para visualizar e pesquisar logs com muitas opções

Instalação

1. Clone o repositório:

git clone https://github.com/Neko-Nik/FastAPI-Template.git
cd FastAPI-Template

2. Crie um ambiente virtual e ative -o:

python3 -m venv virtualenv
source virtualenv/bin/activate

3. Instale as dependências necessárias:

pip3 install -r requirements.txt

Uso

Para executar o aplicativo localmente, usando Uvicorn ou Gunicorn:

Usando Uvicorn: uvicorn api.main:app --reload --port 8086

Usando Gunicorn: gunicorn -k uvicorn.workers.UvicornWorker api.main:app

O aplicativo começará a ser executado no http: // localhost: 8086.

Implantação

Para implantação de produção, o modelo fornece arquivos de configuração do Docker CI e docker-compose para facilitar a implantação.

Contribuindo

As contribuições são bem -vindas! Se você quiser contribuir para o modelo FASTAPI, siga estas etapas:

1. Fork o repositório
2. Crie uma nova filial para o seu recurso ou correção de bug
3. Faça suas alterações e cometê -las
4. Empurre suas alterações no seu garfo
5. Envie uma solicitação de tração ao ramo master do repositório original

Certifique -se de seguir o estilo de código existente e adicione testes para novos recursos ou correções de bugs.

Licença

O modelo FASTAPI é liberado sob a licença do MIT. Você é livre para usar, modificar e distribuir este modelo para qualquer finalidade.