Initial commit

tkrose · tkrose · commit 8afefe302194 · 2020-11-25T16:21:52.000-05:00
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,11 @@
+ FROM alpine:latest
+RUN apk add --no-cache python3-dev \
+    && pip3 install --upgrade pip
+
+WORKDIR /app
+COPY . /app
+
+RUN pip3 --no-cache-dir install -r requirements.txt
+
+ENTRYPOINT ["python3"]
+CMD ["app.py"]
diff --git a/README.md b/README.md
@@ -0,0 +1,10 @@
+# REST API Template
+
+This is an OpenShift-deployable template for a REST API and OpenAPI Specification that leverage Swagger. Please refer to the corresponding tutorial found here:
+
+To run the API:
+    
+> python3 app.py
+
+To check out the Swagger UI, head over to
+    http://0.0.0.0:8080/api/ui/
diff --git a/app.py b/app.py
@@ -0,0 +1,18 @@
+from flask import Flask, render_template
+import connexion
+import requests
+import myapi
+
+#Create the application instance!
+app = connexion.App(__name__, specification_dir='./')
+
+#Read the swagger.yml file to configure the endpoints
+app.add_api('swagger.yml')
+
+#Create a URL route in our application for "/"
+@app.route('/', methods=["GET","POST"])
+def home():
+    return render_template('home.html')
+
+if __name__ == '__main__':
+    app.run(host='0.0.0.0', port=8080, debug=True)
diff --git a/constants.py b/constants.py
@@ -0,0 +1,2 @@
+headers = {
+    'Content-Type': 	'application/json'}
diff --git a/myapi.py b/myapi.py
@@ -0,0 +1,7 @@
+from flask import Flask, render_template, make_response, abort
+
+#Prints a success message after the POST is successfully made.
+#Refer to swagger.yml to see when this runs
+def function():
+    print("We've got a talking API!")
+    return "200"
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,14 @@
+aniso8601==7.0.0
+Click==7.0
+Flask==1.1.1
+Flask-RESTful==0.3.7
+itsdangerous==1.1.0
+Jinja2==2.10.1
+MarkupSafe==1.1.1
+pytz==2019.2
+six==1.12.0
+Werkzeug==0.15.5
+Requests==2.20.0
+connexion==2.7.0
+connexion[swagger-ui]
+swagger-ui-bundle
diff --git a/swagger.yml b/swagger.yml
@@ -0,0 +1,31 @@
+swagger: "2.0"
+info:
+  description: This is the swagger file that goes with our server code
+  version: "1"
+  title: Swagger ReST Article
+consumes:
+  - application/json
+produces:
+  - application/json
+
+basePath: /api
+
+# Paths supported by the server application
+paths:
+  /pathname:
+    post:
+      operationId: app.myapi.function
+      tags:
+        - Requirements
+      summary: Post the entire requirements list
+      description: Provide an object for the API to use in its POST function.
+      parameters:
+        - name: objectName
+          in: body
+          description: Entire the object
+          required: False
+          schema:
+            type: object
+      responses:
+        201:
+          description: Successfully posted object
diff --git a/templates/.gitkeep b/templates/.gitkeep
diff --git a/templates/home.html b/templates/home.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+
+<html lang="en" dir="ltr">
+	<head>
+		<meta charset="utf-8">
+		<title>REST API</title>
+	</head>
+	<div class="container">
+		<nav>
+			<a class="logo" href="{{ url_for('home') }}">Welcome to your REST API!</a>
+		</nav>
+	</div>
+</html>

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+headers = {`
	`2`	`+ 'Content-Type': 'application/json'}`