Merge pull request #110 from pgulb/109-disable-openapi-and-swagger-when-deploying

109 disable openapi and swagger when deploying

Author: pgulb

.github/workflows/deploy-api.yml

@@ -40,4 +40,4 @@ jobs:
         run: |
           echo ${{ secrets.FROG_KEY }} | base64 -d > frog &&
           chmod 600 frog &&
-          ssh -o StrictHostKeyChecking=no -i frog ${{ secrets.FROG_ADDRESS }} -p${{ secrets.FROG_PORT }} "docker run -d -p 30149:6789 -e MONGO_URL='${{ secrets.MONGO_URL }}' --name flush-log-api --restart=unless-stopped ghcr.io/pgulb/flush-log:api"
+          ssh -o StrictHostKeyChecking=no -i frog ${{ secrets.FROG_ADDRESS }} -p${{ secrets.FROG_PORT }} "docker run -d -p 30149:6789 -e DISABLE_OPENAPI='true' -e MONGO_URL='${{ secrets.MONGO_URL }}' --name flush-log-api --restart=unless-stopped ghcr.io/pgulb/flush-log:api"

api/main.py

@@ -24,7 +24,21 @@
 from httpbasic import HTTPBasic
 from models import Feedback, Flush, User
 
-app = fastapi.FastAPI()
+logger = logging.getLogger(__name__)
+logging.getLogger("passlib").setLevel(logging.ERROR)
+
+app_args = {}
+disable_openapi = os.getenv("DISABLE_OPENAPI")
+try:
+    if disable_openapi.lower() == "true":
+        app_args["docs_url"] = None
+        app_args["redoc_url"] = None
+        app_args["openapi_url"] = None
+        logger.info("OpenAPI and Swagger is DISABLED")
+except AttributeError:
+    pass
+app = fastapi.FastAPI(**app_args)
+
 origins = [
     "*",
 ]
@@ -37,9 +51,6 @@
 )
 security = HTTPBasic()
 
-logger = logging.getLogger(__name__)
-logging.getLogger("passlib").setLevel(logging.ERROR)
-
 mongo_setting = os.getenv("MONGO_URL")
 if mongo_setting is None:
     raise ValueError("MONGO_URL not set")