Merge pull request #163 from lendingblock/master

1.2.5

openapi/__init__.py

@@ -1,3 +1,3 @@
 """Minimal OpenAPI asynchronous server application"""
 
-__version__ = '1.2.4'
+__version__ = '1.2.5'

openapi/rest.py

@@ -18,12 +18,13 @@ def rest(
         base_path: str = None,
         commands: typing.List = None,
         allowed_tags: typing.Set = None,
-        validate_docs: bool = False
+        validate_docs: bool = False,
+        OpenApiSpecClass: typing.ClassVar = OpenApiSpec
 ):
     """Create the OpenApi application server
     """
     return OpenApiClient(
-        OpenApiSpec(
+        OpenApiSpecClass(
             OpenApi(**(openapi or {})),
             allowed_tags=allowed_tags,
             validate_docs=validate_docs

openapi/spec/spec.py

@@ -252,13 +252,15 @@ def build(self, app, public=True, private=False):
         ))
         return doc
 
+    def routes(self, app):
+        return app.router.routes()
+
     def _build_paths(self, app, public, private):
         """Loop through app paths and add
         schemas, parameters and paths objects to the spec
         """
         paths = self.paths
-        routes = app.router.routes()
-        for route in routes:
+        for route in self.routes(app):
             route_info = route.get_info()
             path = route_info.get('path', route_info.get('formatter', None))
             handler = route.handler

readme.md

@@ -36,6 +36,35 @@ pytest --cov
 * Asynchronous DB interaction with [asyncpg](https://github.com/MagicStack/asyncpg)
 * Migrations with [alembic](http://alembic.zzzcomputing.com/en/latest/)
 * SqlAlchemy tables as python dataclasses
+* [Click](https://github.com/pallets/click) command line interface
+
+## Web App
+
+to create an openapi RESTful application:
+```python
+def create_app():
+    app = rest(
+        openapi=dict(
+            title='A REST API',
+            ...
+        ),
+        base_path='/v1,
+        allowed_tags=[...],
+        validate_docs=True,
+        setup_app=setup_app,
+        commands=[...]
+    )
+    return app
+
+
+def setup_app(app):
+    app.router.add_routes(...)
+    return app
+
+
+if __name__ == '__main__':
+    create_app().main()
+```
 
 ## Websockets