Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 1.08 KB

README.md

File metadata and controls

45 lines (27 loc) · 1.08 KB

Star Wars

This project provides a Star Wars-themed FastAPI application.

Installation

Choose one of the following installation methods:

Docker

  1. Build the Docker image:

    docker build -t starwars .
    
  2. Run the container, exposing port 8000 for the application:

    docker run -p 8000:8000 starwars
    

Local Environment

  1. Install dependencies:

    pip install -r requirements.txt
    
  2. Navigate to the project's root directory

  3. Run the application:

    uvicorn main:app --reload
    

Swagger Documentation

View the interactive API documentation at http://127.0.0.1:8000/docs (or http://localhost:8000/docs if using Docker).

Testing with Postman You can run all postman test cases in this link: https://www.postman.com/gustavo-starwars/workspace/starwars/collection/15918898-1fe09542-f122-4759-b403-80bc416eb8fb?action=share&creator=15918898

Note: When testing your endpoints with Postman, please ensure to use the correct URL http://127.0.0.1:8000/ or http://localhost:8000/ if using Docker, as the base URL for your requests.