Giter VIP home page Giter VIP logo

fastapi-rest's Introduction

FastAPI-REST

Exemplo de REST API em Python com FastAPI

Instalação

O primeiro passo da instalação é criar um ambiente virtual no diretório do projeto.

Comando para Windows:

C:\Users\Name\FastAPI-REST> python -m venv venv

Comando para Linux e OS X :

$ python3 -m venv venv

Após isso é necessário ativar o ambiente virtual.

Comando para Windows:

C:\Users\Name\FastAPI-REST> venv\Scripts\activate

Comando para Linux e OS X:

$ source venv/bin/activate

Com seu ambiente virtual ativado você deve instalar os pacotes necessários para o projeto:

pip install -r requirements.txt

A API está configurada para salvar os dados em um banco de dados sqlite. Porém, se você desejar utilizar o PostgreSQL basta seguir os seguintes passos:

  1. Criar um banco de dados no PostgreSQL
  2. Criar um arquivo .env na raiz do projeto e incluir a seguinte linha:
SQLALCHEMY_DATABASE_URL = "postgresql://usuario:senha@server/nome_banco"
  1. Comentar as linhas indicadas no arquivo database.py: image

Uso

Com o ambiente virtual ativado digite o seguinte comando no terminal:

uvicorn app.main:app 

Para visualizar a documentação da API e testa-lá basta acessar o link: http://127.0.0.1:8000/docs

Se tudo deu certo você deve visualizar a seguinte tela: docs

fastapi-rest's People

Contributors

william-cirico avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.