add example project

README.md

@@ -14,7 +14,7 @@ Reads an openapi spec and provides automatic routing to Falcon resources. This i
 
 This router inherits from the default Falcon CompiledRouter class, so it supports all methods available to the default router.
 
-Supports json files, yaml files, raw json strings, and raw yaml strings. If no params are specified the plugin will attempt to find `openapi-spec.yml` or `openapi-spec.yaml` in the same directory.
+Supports json files, yaml files, raw json strings, and raw yaml strings. If no params are specified the plugin will attempt to find `openapi-spec.yml` or `openapi-spec.yaml` in the current working directory (see example for structure).
 
 ```python
 import falcon

example/Pipfile

@@ -0,0 +1,14 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+
+[packages]
+falcon = "*"
+gunicorn = "*"
+falcon-openapi = "*"
+
+[requires]
+python_version = "3.7"

example/look/api/controller.py

@@ -0,0 +1,6 @@
+from look.model.model import model1
+
+
+class controller1(object):
+    def on_get(self, req, resp):
+        resp.body = "test"

example/look/app.py

@@ -0,0 +1,11 @@
+from wsgiref import simple_server
+
+import falcon
+
+from falcon_openapi import OpenApiRouter
+
+api = application = falcon.API(router=OpenApiRouter(file_path="openapi-spec.yaml"))
+
+if __name__ == "__main__":
+    httpd = simple_server.make_server("127.0.0.1", 8000, api)
+    httpd.serve_forever()

example/look/model/model.py

@@ -0,0 +1,5 @@
+# just an example class to import in controller
+
+
+class model1:
+    pass

example/openapi-spec.yaml

@@ -0,0 +1,11 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Falcon Openapi Example
+  license:
+    name: MIT
+paths:
+  /controller:
+    get:
+      summary: summary
+      operationId: api.controller.controller1.on_get