Git Product home page Git Product logo

fib-fast-api's Introduction

README - Projeto API Fibonacci

Este é um projeto de exemplo que implementa uma API REST em Python usando o framework FastAPI junto do Uvicorn. A API possui duas rotas:

  1. Rota de Saúde (/api/health):

    • Responde a uma requisição GET com a mensagem "Estou saudável", indicando que o servidor está funcionando corretamente.
  2. Rota de Fibonacci (/api/fibonacci):

    • Recebe uma requisição POST com um número de elementos e retorna uma lista contendo os elementos da sequência de Fibonacci até o número especificado.
    • Exemplo de entrada: {"elementos": 7}
    • Saída correspondente: [0, 1, 1, 2, 3, 5, 8]

Pré-requisitos

Antes de começar, certifique-se de ter os seguintes pré-requisitos instalados:

  • Python 3.10 ou posterior
  • Docker
  • Um ambiente de desenvolvimento ou servidor com acesso à internet para clonar o repositório e executar a aplicação.

Instruções de Uso

Rodar Localmente

  1. Entre no repositorio

    cd fib-fast-api
  2. Instale as dependencias

    pip install -r requirements.txt
  3. Rode o servidor

    uvicorn src.app:app --host 0.0.0.0 --port 8000 --reload

A API estará disponível em http://localhost:8000.

Docs

You can check our swagger documentation by entering http://localhost:8000/docs

Docker

  1. Contrua a imagem

    docker build -t fastapi-app .
  2. Inicie o container

    docker run -p 8000:8000 fastapi-app

A API estará disponível em http://localhost:8000.

Testando as Rotas

Agora que a aplicação está em execução, você pode testar as rotas usando ferramentas como curl ou Postman.

  1. GET /api/health

    curl -X GET http://localhost:8000/api/health
    "Estou saudável"
  2. POST /api/fibonacci

    curl -X POST -H "Content-Type: application/json" -d '{"elementos": 4}' http://localhost:8000/api/fibonacci
    [ 0, 1, 1, 2]
    

Testes

Essa aplicação possui testes unitários, voce pode executar-los para garantir que o codigo funciona como esperado.

  1. Entrar no projeto

    cd fib-fast-api
  2. Executar os testes

    python -m unittest discover tests/

fib-fast-api's People

Contributors

caiocordeiro 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.