Openapi proxy example (#112)

Author: akrambek

openapi.proxy/README.md

@@ -0,0 +1,29 @@
+# openapi.proxy
+## Running locally
+
+This example runs using Docker compose. You will find the setup scripts in the [compose](./docker/compose) folder.
+
+### Setup
+
+The `setup.sh` script will:
+
+- Configured Zilla instance
+- Start openapi-mock
+
+```bash
+./compose/setup.sh
+```
+
+### Test
+
+```bash
+curl --location 'http://localhost:7114/pets' --header 'Accept: application/json'
+```
+
+### Teardown
+
+The `teardown.sh` script will remove any resources created.
+
+```bash
+./compose/teardown.sh
+```

openapi.proxy/docker/compose/docker-compose.yaml

@@ -0,0 +1,27 @@
+version: '3'
+services:
+  zilla:
+    image: ghcr.io/aklivity/zilla:latest
+    container_name: zilla
+    pull_policy: always
+    restart: unless-stopped
+    ports:
+      - 7114:7114
+    environment:
+      ZILLA_INCUBATOR_ENABLED: true
+    volumes:
+      - ../../specs/schema.json:/etc/zilla/schema.json
+      - ../../zilla.yaml:/etc/zilla/zilla.yaml
+    command: start -v -e
+
+  openapi-mock:
+    image: jormaechea/open-api-mocker
+    platform: linux/amd64
+    volumes:
+      - ../../specs:/app
+    ports:
+      - "8000:5000"
+
+networks:
+  default:
+    driver: bridge

openapi.proxy/docker/compose/setup.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -e
+
+NAMESPACE=zilla-openapi-proxy
+# Start or restart Zilla
+if [[ -z $(docker-compose -p $NAMESPACE ps -q zilla) ]]; then
+  docker-compose -p $NAMESPACE up -d
+else
+  docker-compose -p $NAMESPACE restart --no-deps zilla
+fi

openapi.proxy/docker/compose/teardown.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -e
+
+NAMESPACE=zilla-openapi-proxy
+docker-compose -p $NAMESPACE down --remove-orphans

openapi.proxy/specs/schema.json

@@ -0,0 +1,126 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Swagger Petstore",
+    "license": {
+      "name": "MIT"
+    }
+  },
+  "servers": [
+    {
+      "url": "http://localhost:7114"
+    }
+  ],
+  "paths": {
+    "/pets": {
+      "get": {
+        "summary": "List all pets",
+        "operationId": "listPets",
+        "tags": [
+          "pets"
+        ],
+        "responses": {
+          "200": {
+            "description": "A paged array of pets",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Pets"
+                }
+              }
+            }
+          },
+          "default": {
+            "description": "unexpected error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "summary": "Create a pet",
+        "operationId": "createPets",
+        "tags": [
+          "pets"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/Pet"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "Null response"
+          },
+          "default": {
+            "description": "unexpected error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Pet": {
+        "type": "object",
+        "required": [
+          "id",
+          "name"
+        ],
+        "properties": {
+          "id": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "name": {
+            "type": "string"
+          },
+          "tag": {
+            "type": "string"
+          }
+        }
+      },
+      "Pets": {
+        "type": "array",
+        "maxItems": 100,
+        "items": {
+          "$ref": "#/components/schemas/Pet"
+        }
+      },
+      "Error": {
+        "type": "object",
+        "required": [
+          "code",
+          "message"
+        ],
+        "properties": {
+          "code": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "message": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}

openapi.proxy/zilla.yaml

@@ -0,0 +1,20 @@
+---
+name: zilla-openapi-proxy
+bindings:
+  north_openapi_server:
+    type: openapi
+    kind: server
+    options:
+      specs:
+        my-openapi-spec: schema.json
+    exit: south_openapi_lcient
+  south_openapi_lcient:
+    type: openapi
+    kind: client
+    options:
+      specs:
+        my-openapi-spec: schema.json
+      tcp:
+        host: openapi-mock
+        port:
+          - 5000