Giter Club home page Giter Club logo

flask_sample_api_with_dockerization's Introduction

Flask sample api with dockerization

Features โœจ

Hello world

  • Endpoint /
    • request : None
    • response: String "Hello world"

Echo request word

  • Endpoint /echo/[somedata]
    • request : Any String
    • response: application/json
      { "echo": "somedata" }

Convert number to human readable word

  • Endpoint /api/numtoword/[number]
    • request : Any integer
    • response: application/json
      {
          "en_word": "english number word",
          "th_word": "thai number word"
      }

Run server ๐Ÿƒโ€

Install dependencies

pip install -r requirements.txt

Start server

python server/server.py


Development ๐Ÿ‘จโ€๐Ÿ’ป

You may need to create virtual python env like this

# macOS/Linux
# You may need to run sudo apt-get install python3-venv first
python3 -m venv .venv

# Windows
# You can also use py -3 -m venv .venv
python -m venv .venv

For VS Code please create .env file

echo PYTHONPATH=server >> .env

Deployment ๐Ÿณ

Build your image

docker build -t flask-sample:[tag-name] -f Dockerfile .

If behind proxy

docker build --build-arg http_proxy=http://host:port --build-arg https_proxy=http://host:port -t flask-sample:[tag-name] .

Quickly Run your image as container

docker run -d -p XXXX:8080 flask-sample:[tag-name]

โš  This project use python 3.7.X 32-bit to run server

flask_sample_api_with_dockerization's People

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.