Skip to content

amathur2k/rest-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Simple FastAPI File Processing API

This is a basic FastAPI application that demonstrates file uploads and downloads.

Setup

  1. Create a virtual environment (optional but recommended):

    python -m venv venv
    source venv/bin/activate  # On Windows use `venv\Scripts\activate`
  2. Install dependencies:

    pip install -r requirements.txt

Running the API

Use uvicorn to run the application:

uvicorn main:app --reload

This will start the server, typically at http://127.0.0.1:8000.

Usage

  • Navigate to http://127.0.0.1:8000 in your browser to see the welcome message.

  • Navigate to http://127.0.0.1:8000/docs for the interactive API documentation (Swagger UI).

  • Use a tool like curl or Postman to send a POST request to the /processfile/ endpoint with a file attached.

    Example using curl:

    curl -X POST "http://127.0.0.1:8000/processfile/" -F "file=@your_file_name.txt" -o output.txt

    Replace your_file_name.txt with the path to the file you want to upload. The processed (mocked) output will be saved to output.txt.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published