Adding Swagger Documentation

README.md

@@ -169,6 +169,8 @@ class Api(Assembly):
 
 - Inbuilt development server
 
+- Swagger Documentation
+
 
 ---
 
@@ -315,6 +317,9 @@ Two endpoints will be available:
 - `http://127.0.0.1:5000/` which will show an HTML
 - `http://127.0.0.1:5000/api/` which will a json response
 
+For Swagger Documentation:
+
+- `http://127.0.0.1:5000/apidocs` which will show you the Swagger UI
 
 --- 
 

assembly/cli.py

@@ -139,6 +139,7 @@ def init():
         print("%s is setup successfully!" % about.__title__)
         print("")
         print("> To do:")
+        print("- Run Pip Install to install other dependencies")
         print("- Edit application's config [ ./config.py ] ")
         print("- Create your Models/Database tables, then run [ asm-admin sync-models ]")        
         print("- Create your commands in [ cli.py ] and run your setup command [ asm setup ]")

assembly/scaffold/init/config.py

@@ -292,6 +292,18 @@ class BaseConfig(object):
     #: Directory to store cache if CACHE_TYPE is filesystem, it will
     CACHE_DIR = ""
 
+    #--------- SWAGGER ----------
+    #: Flassger is used to render Swagger Docs
+
+    #: SWAGGER_TITLE
+    #: Name of the Application
+    SWAGGER_TITLE = "Assembly"
+
+    #: SWAGGER_UI_VERSION
+    #: The type of Swagger UI to render
+    #: 2 or 3 default: 3
+    SWAGGER_UI_VERSION = "3"
+
 
 # -------------------------- ENVIRONMENT BASED CONFIG ---------------------------
 """

assembly/scaffold/init/main/__init__.py

@@ -74,6 +74,30 @@ def index(self):
     @request.cors
     @response.json
     def api(self):
+        """API Endpoint with CORS and JSON response
+    This is using docstrings for specifications.
+    ---
+    definitions:
+      Endpoint:
+        type: object
+        properties:
+          date:
+            type: date
+          description:
+            type: string
+        items:
+        $ref: '#/definitions/Endpoint'
+    responses:
+      200:
+        description: API Endpoint with CORS and JSON response
+        schema:
+          $ref: '#/definitions/Endpoint'
+        examples:
+          response: {
+              "date": "2019-11-29T18:28:07.125075+00:00",
+              "description": "API Endpoint with CORS and JSON response"
+          }
+    """
         return {
             "date": date.utcnow(),
             "description": "API Endpoint with CORS and JSON response"

assembly/scaffold/init/requirements.txt

@@ -1,3 +1,4 @@
 # Assembly 
 # ---------------------------
 assembly
+flasgger

assembly/scaffold/init/wsgi.py

@@ -34,6 +34,11 @@
 """
 from assembly import Assembly
 
+"""
+Importing Swagger Supporting Library
+"""
+from flasgger import Swagger
+
 """
 If you want to use your views CLI, you can import them below
 """
@@ -58,3 +63,13 @@
 the 'app' variable is required
 """
 app = Assembly.init(__name__, APPS)
+
+"""
+Initialize the Swagger Docs
+"""
+app.config["SWAGGER"] = {
+    "title": app.config.get("SWAGGER_TITLE"),
+    "uiversion": app.config.get("SWAGGER_UI_VERSION"),
+}
+
+Swagger(app)