First Commit

Author: natthasath

.env.example

@@ -0,0 +1,5 @@
+APP_HOST = '0.0.0.0'
+APP_PORT = 8000
+
+SSL_CERTIFICATE = '/etc/ssl/certs/certificate.crt'
+SSL_KEYFILE = '/etc/ssl/private/private.key'

.gitattributes

@@ -0,0 +1,2 @@
+* linguist-detectable=false
+*.yml linguist-detectable=true

.gitignore

@@ -0,0 +1,4 @@
+__pycache__/
+*.pyc
+*.pyo
+*.env

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Natthasath Saksupanara
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,16 @@
+# 🎉 Template Python FastAPI
+
+FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints. It has a simple and easy to use API, is lightweight, and includes features like asynchronous support, dependency injection, and more.
+
+![version](https://img.shields.io/badge/version-1.0-blue)
+![rating](https://img.shields.io/badge/rating-★★★★★-yellow)
+![uptime](https://img.shields.io/badge/uptime-100%25-brightgreen)
+
+### 🏆 Run
+
+- [http://localhost:8000/docs](http://localhost:8000/docs)
+- [http://localhost:8000/subapi/docs](http://localhost:8000/subapi/docs)
+
+```shell
+docker-compose up -d --scale app=3
+```

app/api.py

@@ -0,0 +1,55 @@
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+from app.routers import template
+from app.tag import SubTags, Tags
+
+app = FastAPI(
+    title="FastAPI",
+    description="Web API helps you do awesome stuff. 🚀",
+    version="0.0.1",
+    terms_of_service="http://example.com/terms/",
+    contact={
+        "name": "Information and Digital Technology Center (IDT)",
+        "url": "https://codeinsane.wordpress.com/",
+        "email": "natthasath.sak@gmail.com",
+    },
+    license_info={
+        "name": "Apache 2.0",
+        "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
+    },
+    openapi_url="/api/v1/openapi.json",
+    docs_url="/docs",
+    openapi_tags=Tags(),
+    swagger_ui_parameters={"defaultModelsExpandDepth": -1}
+)
+
+origins = ["*"]
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=origins,
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
+
+app.include_router(template.router)
+#
+#
+#
+
+subapi = FastAPI(openapi_tags=SubTags(), swagger_ui_parameters={"defaultModelsExpandDepth": -1})
+
+subapi.add_middleware(
+    CORSMiddleware,
+    allow_origins=origins,
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
+
+subapi.include_router(template.router)
+#
+#
+#
+
+app.mount("/subapi", subapi)

app/doc/.gitkeep

@@ -0,0 +1,24 @@
+from fastapi import Form
+from pydantic import BaseModel, Field, EmailStr, SecretStr
+from typing import List, Union
+import inspect
+
+def form_body(cls):
+    cls.__signature__ = cls.__signature__.replace(
+        parameters=[
+            arg.replace(default=Form(default = arg.default) if arg.default is not inspect._empty else Form(...))
+            for arg in cls.__signature__.parameters.values()
+        ]
+    )
+    return cls
+
+@form_body
+class TemplateSchema(BaseModel):
+    id: int = Field(default=None)
+
+    class Config:
+        schema_extra = {
+            "example": {
+                "id": "Incremental Number"
+            }
+        }

app/font/.gitkeep

@@ -0,0 +1,12 @@
+from fastapi import APIRouter, Depends, Form
+from fastapi.responses import JSONResponse
+
+router = APIRouter(
+    prefix="/template",
+    tags=["TEMPLATE"],
+    responses={404: {"message": "Not found"}}
+)
+
+@router.get("/")
+async def root():
+    return {"message": "Hello World"}

app/handler/.gitkeep

@@ -0,0 +1,6 @@
+from decouple import config
+from fastapi.responses import JSONResponse
+
+class TemplateService:
+    def __init__(self):
+        self.config = config("CONF_NAME")

app/img/.gitkeep

@@ -0,0 +1,25 @@
+def Tags():
+    tags_metadata = [
+        {
+            "name": "AUTHENTICATION",
+            "description": "Authentication using JSON Web Tokens (JWT) with **PyJWT** for sign, encode, and decode",
+            "externalDocs": {
+                "description": "Items external docs",
+                "url": "https://testdriven.io/blog/fastapi-jwt-auth/",
+            },
+        },
+    ]
+    return tags_metadata
+
+def SubTags():
+    tags_metadata = [
+         {
+            "name": "AUTHENTICATION",
+            "description": "Authentication using JSON Web Tokens (JWT) with **PyJWT** for sign, encode, and decode",
+            "externalDocs": {
+                "description": "Items external docs",
+                "url": "https://testdriven.io/blog/fastapi-jwt-auth/",
+            },
+        },
+    ]
+    return tags_metadata

app/json/.gitkeep

@@ -0,0 +1,20 @@
+worker_processes 1;
+
+events { worker_connections 1024; }
+
+http {
+    upstream myapi {
+        server app:8000;
+    }
+
+    server {
+        listen 80;
+        server_name example.com;
+
+        location / {
+            proxy_pass http://myapi;
+            proxy_set_header Host $host;
+            proxy_set_header X-Real-IP $remote_addr;
+        }
+    }
+}

app/log/access.log

@@ -0,0 +1,6 @@
+**/.env
+**/.aws
+**/.ssh
+__pycache__/
+*.pyc
+*.pyo

app/models/model_template.py

@@ -0,0 +1,15 @@
+FROM python:3.9
+
+WORKDIR /code
+
+COPY ./requirements.txt /code/requirements.txt
+COPY ./.env /code/.env
+COPY ./main.py /code/main.py
+COPY ./app /code/app
+
+COPY ./certs/certificate.crt /etc/ssl/certs/
+COPY ./certs/private.key /etc/ssl/private/
+
+RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
+
+CMD ["python", "main.py"]

app/routers/template.py

@@ -0,0 +1,31 @@
+version: '3.9'
+services:
+  app:
+    build:
+      context: ../
+      dockerfile: docker/Dockerfile
+    container_name: app
+    restart: always
+    ports:
+      - 8000:8000
+    networks:
+      - default
+
+  nginx:
+    image: nginx:latest
+    container_name: nginx
+    restart: always
+    ports:
+      - 80:80
+    networks:
+      - default
+    volumes:
+      - ./config/nginx.conf:/etc/nginx/nginx.conf
+
+networks:
+  default:
+    driver: bridge
+
+volumes:
+  data:
+    driver: local

app/services/service_template.py

@@ -0,0 +1,6 @@
+import uvicorn
+from decouple import config
+
+if __name__ == "__main__":
+    uvicorn.run("app.api:app", host=str(config("APP_HOST")), port=int(config("APP_PORT")), reload=True)
+    # uvicorn.run("app.api:app", host=str(config("APP_HOST")), port=int(config("APP_PORT")), reload=True, ssl_certfile=config("SSL_CERTIFICATE"), ssl_keyfile=config("SSL_KEYFILE"))