container-images/python-api-server

Archived

This repository has been archived on 2024-11-06. You can view files and clone it, but cannot push or open issues or pull requests.

mg 13a3ab0076 add swagger (#1 )

Co-authored-by: Michael Grote <michael.grote@posteo.de>
Reviewed-on: mg/python-api-server#1

2023-04-25 20:52:45 +02:00

887 B

Raw Blame History

python-api-server

a small flask-application for storing and downloading stuff like small binaries

Variables

MAX_CONTENT_LENGTH: maximal Filesize in MB; defaults to 5MB
UPLOAD_DIRECTORY: where to store the uploaded files; should be mapped to a volume; defaults to "/uploads"
AUTH_TOKEN: token used for authenticating

Example Docker-Compose

version: '3'
services:
  python-api-server:
    container_name: httpd-api
    image: quotengrote/python-api-server:v2
    ports:
      - "5040:5000"
    volumes:
      - uploads:/uploads
    environment:
      # FLASK_DEBUG: 1 # for debugging
      # FLASK_APP: app # for debugging
      MAX_CONTENT_LENGTH: 10
      UPLOAD_DIRECTORY: /uploads
      AUTH_TOKEN: myuploadtoken

volumes:
  uploads:

API-Endpoints

see Flasgger: http://<host>:5040/apidocs/