Add sample application

Author: jdkandersson

examples/app/api.py

@@ -0,0 +1,50 @@
+"""Functions handling API endpoints."""
+
+from models import Employee
+from models import db
+
+
+def search():
+    """Get all employees from the database."""
+    employees = Employee.query.all()
+    employee_dicts = map(lambda employee: employee.to_dict(), employees)
+    return list(employee_dicts)
+
+
+def post(body):
+    """Save an employee to the database."""
+    if Employee.query.filter_by(id=body["id"]).first() is not None:
+        return ("Employee already exists.", 400)
+
+    employee = Employee(**body)
+    db.session.add(employee)
+    db.session.commit()
+
+
+def get(id):
+    """Get an employee from the database."""
+    employee = Employee.query.filter_by(id=id).first()
+    if employee is None:
+        return ("Employee not found.", 404)
+    return employee.to_dict()
+
+
+def patch(body, id):
+    """Update an employee in the dayabase."""
+    employee = Employee.query.filter_by(id=id).first()
+    if employee is None:
+        return ("Employee not found.", 404)
+    employee.name = body["name"]
+    employee.division = body["division"]
+    employee.salary = body["salary"]
+    db.session.commit()
+    return 200
+
+
+def delete(id):
+    """Delete an employee from the database."""
+    result = Employee.query.filter_by(id=id).delete()
+    if not result:
+        return ("Employee not found.", 404)
+    db.session.commit()
+    return 200

examples/app/api.yaml

@@ -0,0 +1,123 @@
+
+openapi: "3.0.0"
+
+info:
+  title: Test Schema
+  description: API to illustrate OpenAPI-SQLALchemy.
+  version: "1.0"
+
+paths:
+  /employee:
+    get:
+      operationId: api.search
+      summary: Used to retrieve all employees.
+      responses:
+        200:
+          description: Return all employees from the database.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/Employee"
+    post:
+      operationId: api.post
+      summary: Used to save an employee to the database.
+      requestBody:
+        description: The employee to save.
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/Employee"
+      responses:
+        200:
+          description: Save successful.
+        400:
+          description: The Employee already exists.
+  /employee/{id}:
+    get:
+      operationId: api.get
+      summary: Used to retrieve an Employee from the database.
+      parameters:
+        - in: path
+          name: id
+          schema:
+            type: integer
+          required: true
+      responses:
+        200:
+          description: The Employee.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Employee"
+        404:
+          description: The Employee was not found.
+    patch:
+      operationId: api.patch
+      summary: Update an Employee in the database.
+      parameters:
+        - in: path
+          name: id
+          schema:
+            type: integer
+          required: true
+      requestBody:
+        description: The employee to save.
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/Employee"
+      responses:
+        200:
+          description: The Employee was updated.
+        404:
+          description: The Employee was not found.
+    delete:
+      operationId: api.delete
+      summary: Delete an Employee from the database.
+      parameters:
+        - in: path
+          name: id
+          schema:
+            type: integer
+          required: true
+      responses:
+        200:
+          description: The Employee was deleted.
+        404:
+          description: The Employee was not found.
+
+components:
+  schemas:
+    Employee:
+      description: Person that works for a company.
+      type: object
+      x-tablename: employee
+      properties:
+        id:
+          type: integer
+          description: Unique identifier for the employee.
+          example: 0
+          x-primary-key: true
+          x-autoincrement: true
+        name:
+          type: string
+          description: The name of the employee.
+          example: David Andersson.
+          x-index: true
+        division:
+          type: string
+          description: The part of the company the employee works in.
+          example: Engineering
+          x-index: true
+        salary:
+          type: number
+          description: The amount of money the employee is paid.
+          example: 1000000.00
+      required:
+        - id
+        - name
+        - division

examples/app/app.py

@@ -0,0 +1,13 @@
+"""Application code."""
+
+import connexion
+
+from models import db
+
+app = connexion.FlaskApp(__name__, specification_dir=".")
+app.app.config["SQLALCHEMY_DATABASE_URI"] = "sqlite:///:memory:"
+db.init_app(app.app)
+with app.app.app_context():
+    db.create_all()
+app.add_api("api.yaml")
+app.run(port=8080)

examples/app/models.py

@@ -0,0 +1,25 @@
+"""Database models."""
+
+from flask_sqlalchemy import SQLAlchemy
+from yaml import safe_load
+
+from openapi_sqlalchemy import init_model_factory
+
+db = SQLAlchemy()
+
+with open("api.yaml") as spec_file:
+    SPEC = safe_load(spec_file)
+MODEL_FACTORY = init_model_factory(base=db.Model, spec=SPEC)
+
+
+class Employee(MODEL_FACTORY(name="Employee")):
+    """Employee model with serialization function."""
+
+    def to_dict(self):
+        """Convert Employee to a dictionary."""
+        return {
+            "id": self.id,
+            "name": self.name,
+            "division": self.division,
+            "salary": self.salary,
+        }

examples/app/requirements.txt

@@ -0,0 +1,2 @@
+connexion[swagger-ui]==2.4
+Flask-SQLAlchemy==2.4