├── .dockerignore ├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── asgi.py ├── config.json ├── docker-compose.yml ├── requirements.txt └── tests ├── __init__.py ├── conftest.py └── test_asgi.py /.dockerignore: -------------------------------------------------------------------------------- 1 | venv 2 | LICENSE 3 | README.md 4 | .gitignore -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | test_tmpdir.py 131 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # Using base image provided by nginx unit 2 | FROM nginx/unit:1.22.0-python3.9 3 | # Alternatively you can use different tags from https://hub.docker.com/r/nginx/unit 4 | 5 | COPY requirements.txt /fastapi/requirements.txt 6 | 7 | RUN pip install -r /fastapi/requirements.txt 8 | 9 | COPY config.json /docker-entrypoint.d/config.json 10 | 11 | COPY . /fastapi -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 Sushrut Ashtikar 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # fastapi-nginx-unit 2 | A simple 'hello world' app of FastAPI running on NGINX Unit App server using ASGI. 3 | 4 | ## Running on Docker 5 | ```bash 6 | docker-compose up --build 7 | ``` 8 | After that you can test using `curl` command. 9 | ```bash 10 | curl http://localhost 11 | ``` 12 | 13 | ## Running test cases (docker) 14 | ```bash 15 | # Run the docker server if you haven't started it yet then run below command for executing test cases 16 | docker-compose exec api pytest /fastapi 17 | ``` 18 | 19 | ## Running from terminal 20 | 1. Create venv in your project directory and install fastapi 21 | ```bash 22 | $ python3 -m venv apienv 23 | $ source apienv/bin/activate 24 | (venv)$ pip install --upgrade pip 25 | (venv)$ pip install -r requirements.txt 26 | $ deactivate 27 | ``` 28 | 2. Run the following command for each directory containing app code or data so Unit can access it: 29 | ```bash 30 | (venv)$ sudo chown -R unit:unit /path/to/app/ 31 | ``` 32 | 3. Create a JSON configuration file containing information about application. 33 | ```json 34 | // config.json 35 | { 36 | "listeners": { 37 | "*:80": { 38 | "pass": "applications/fastapi" 39 | } 40 | }, 41 | 42 | "applications": { 43 | "fastapi": { 44 | "type": "python 3.x", 45 | "path": "/path/to/app/", 46 | "home": "/path/to/app/venv/", 47 | "module": "asgi", 48 | "callable": "app" 49 | } 50 | } 51 | } 52 | ``` 53 | 4. Run the server 54 | ```bash 55 | (venv)$ unitd 56 | ``` 57 | 5. Push the configurations json file on server 58 | ```bash 59 | (venv)$ sudo curl -X PUT --data-binary @config.json --unix-socket \ 60 | /path/to/control.unit.sock http://localhost/config/ 61 | ``` 62 | 6. Testing (terminal) 63 | ```bash 64 | (venv)$ pytest . 65 | ``` -------------------------------------------------------------------------------- /asgi.py: -------------------------------------------------------------------------------- 1 | from fastapi import FastAPI 2 | 3 | app = FastAPI() 4 | 5 | 6 | @app.get("/") 7 | async def index(): 8 | """ 9 | A simple Hello World GET request 10 | """ 11 | return {"message": "Hello, World!"} 12 | -------------------------------------------------------------------------------- /config.json: -------------------------------------------------------------------------------- 1 | { 2 | "listeners": { 3 | "*:80": { 4 | "pass": "applications/fastapi" 5 | } 6 | }, 7 | 8 | "applications": { 9 | "fastapi": { 10 | "type": "python 3.9", 11 | "path": "/fastapi", 12 | "home": "/usr/local", 13 | "module": "asgi", 14 | "callable": "app" 15 | } 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3.7' 2 | 3 | services: 4 | api: 5 | container_name: fastapi_demo 6 | build: . 7 | ports: 8 | - 80:80 -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | fastapi==0.63.0 2 | 3 | # dev-requirements 4 | pytest==6.2.2 5 | requests==2.25.1 -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/novasush/fastapi-nginx-unit/f2766b1f7cb479d767330cb696cde8e9dfe37899/tests/__init__.py -------------------------------------------------------------------------------- /tests/conftest.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from starlette.testclient import TestClient 3 | 4 | from asgi import app 5 | 6 | 7 | @pytest.fixture(scope="module") 8 | def test_app(): 9 | client = TestClient(app) 10 | yield client # testing happens here 11 | -------------------------------------------------------------------------------- /tests/test_asgi.py: -------------------------------------------------------------------------------- 1 | def test_index(test_app): 2 | response = test_app.get("/") 3 | assert response.status_code == 200 4 | assert response.json() == {"message": "Hello, World!"} 5 | --------------------------------------------------------------------------------