Devportal alpha release commit

Author: fabriziofiorucci

Dockerfile

@@ -0,0 +1,19 @@
+FROM alpine:latest
+
+RUN apk update && apk upgrade && \
+    apk add --update --no-cache python3 
+
+WORKDIR /deployment
+
+COPY etc/ etc/
+COPY src/ src/
+COPY templates/ templates/
+
+RUN python3 -m venv /deployment/env/ && \
+    source /deployment/env/bin/activate && \
+#    python3 -m pip install --upgrade pip && \
+    pip3 install --no-cache --upgrade pip setuptools virtualenv && \
+    pip3 install -r src/requirements.txt
+
+WORKDIR /deployment/src
+CMD ["/deployment/env/bin/python3", "./main.py"]

contrib/devportal/Dockerfile

@@ -0,0 +1,15 @@
+FROM redocly/cli
+
+WORKDIR /deployment
+
+COPY src/ src/
+
+RUN apk update && \
+    apk add --update --no-cache bash python3 && \
+    python3 -m ensurepip && \
+    pip3 install --no-cache --upgrade pip setuptools virtualenv && \
+    virtualenv /deployment/env/ && source /deployment/env/bin/activate && \
+    python3 -m pip install --upgrade pip && \
+    pip3 install -r /deployment/src/requirements.txt
+
+ENTRYPOINT [ "/deployment/src/start.sh" ]

contrib/devportal/README.md

@@ -0,0 +1,15 @@
+# Developer portal add-on
+
+This is a wrapper for [Redocly CLI](https://redocly.com/docs/cli/) used by the NGINX declarative API to create and publish developer portals
+
+To build:
+
+	docker build --no-cache -t <YOUR_TARGET_IMAGE_NAME> .
+
+To run the pre-build image:
+
+	docker run --rm -d -p 5001:5000 --name devportal fiorucci/nginx-declarative-api-devportal
+
+To test:
+
+	curl -i -w '\n' 127.0.0.1:5001/v1/devportal -X POST -H "Content-Type: application/json" -d @<OPENAPI_JSON_SCHEMA_FILENAME>

contrib/devportal/src/requirements.txt

@@ -0,0 +1,4 @@
+typing
+uvicorn
+fastapi
+uuid

contrib/devportal/src/server.py

@@ -0,0 +1,55 @@
+import pathlib
+import uvicorn
+import subprocess
+import json
+import uuid
+
+from typing import Any, Dict, AnyStr, List, Union
+
+from fastapi import FastAPI, Request
+from fastapi.responses import PlainTextResponse, Response, JSONResponse
+
+app = FastAPI(
+    title="Redoc connector",
+    version="1.0.0",
+    contact={"name": "GitHub", "url": "https://github.com/fabriziofiorucci/NGINX-Declarative-API"}
+)
+
+JSONObject = Dict[AnyStr, Any]
+JSONArray = List[Any]
+JSONStructure = Union[JSONArray, JSONObject]
+
+@app.post("/v1/devportal", status_code=200, response_class=JSONResponse)
+def post_devportal(response: Response, request: JSONStructure = None):
+    if request:
+        try:
+            sessionUUID = uuid.uuid4()
+            apiSchema = json.dumps(request)
+            tmpFileBase = f"/tmp/{sessionUUID}"
+            tmpFileSchema = f"{tmpFileBase}.json"
+            tmpFileDocs = f"{tmpFileBase}.html"
+            tmpFile = open(tmpFileSchema,"w")
+            tmpFile.write(apiSchema)
+            tmpFile.close()
+
+            output = subprocess.check_output(f"redocly build-docs '{tmpFileSchema}' --output={tmpFileDocs}", shell=True)
+
+            with open(tmpFileDocs, 'r') as file:
+                devPortal = file.read().replace('\n','')
+
+            return JSONResponse (content={'status': 'success','apischema': f'{apiSchema}','devportal': f'{devPortal}'}, status_code=200)
+        except subprocess.CalledProcessError as e:
+            return JSONResponse (content={'status': str(e)}, status_code=400)
+        finally:
+            schemaFile = pathlib.Path(tmpFileSchema)
+            if schemaFile.is_file():
+                schemaFile.unlink()
+
+            docsFile = pathlib.Path(tmpFileDocs)
+            if docsFile.is_file():
+                docsFile.unlink()
+    else:
+        return JSONResponse (content={'status': 'invalid body'}, status_code=400)
+
+if __name__ == '__main__':
+    uvicorn.run("server:app", host='0.0.0.0', port=5000)

contrib/devportal/src/start.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+# https://redocly.com/docs/cli/commands/build-docs/
+
+# Disable telemetry collection
+# https://github.com/Redocly/redocly-cli/#data-collection
+export REDOCLY_TELEMETRY=off
+
+/deployment/env/bin/python /deployment/src/server.py