documentation view: dynamic render of doc instead rite file

hapic/doc.py

@@ -191,15 +191,13 @@ class DocGenerator(object):
 
         return spec.to_dict()
 
-    def save_in_file(
+    def get_doc_yaml(
         self,
-        doc_file_path: str,
         controllers: typing.List[DecoratedController],
         context: ContextInterface,
-        title: str='',
-        description: str='',
-    ) -> None:
-        # generate this file
+        title: str = '',
+        description: str = '',
+    ) -> str:
         dict_doc = self.get_doc(
             controllers=controllers,
             context=context,
@@ -211,9 +209,24 @@ class DocGenerator(object):
         # We dump then load with json to use real scalar dict.
         # If not, yaml dump dict-like objects
         clean_dict_doc = json.loads(json_doc)
-        yaml_doc = yaml.dump(clean_dict_doc, default_flow_style=False)
+        return yaml.dump(clean_dict_doc, default_flow_style=False)
+
+    def save_in_file(
+        self,
+        doc_file_path: str,
+        controllers: typing.List[DecoratedController],
+        context: ContextInterface,
+        title: str='',
+        description: str='',
+    ) -> None:
+        doc_yaml = self.get_doc_yaml(
+            controllers=controllers,
+            context=context,
+            title=title,
+            description=description,
+        )
         with open(doc_file_path, 'w+') as doc_file:
-            doc_file.write(yaml_doc)
+            doc_file.write(doc_yaml)
 
 
 # TODO BS 20171109: Must take care of already existing definition names

hapic/hapic.py

@@ -420,9 +420,20 @@ class Hapic(object):
             swaggerui_path,
         )
 
-        # Generate documentation file
-        doc_page_path = os.path.join(swaggerui_path, 'spec.yml')
-        self.save_doc_in_file(doc_page_path)
+        # Documentation file view
+        doc_yaml = self.doc_generator.get_doc_yaml(
+            controllers=self._controllers,
+            context=self.context,
+            title=title,
+            description=description,
+        )
+
+        def spec_yaml_view():
+            return self.context.get_response(
+                doc_yaml,
+                mimetype='text/x-yaml',
+                http_code=HTTPStatus.OK,
+            )
 
         # Prepare views html content
         doc_index_path = os.path.join(swaggerui_path, 'index.html')
@@ -447,3 +458,10 @@ class Hapic(object):
             http_method='GET',
             view_func=api_doc_view,
         )
+
+        # Add a doc yaml view
+        self.context.add_view(
+            route=os.path.join(route, 'spec.yml'),
+            http_method='GET',
+            view_func=spec_yaml_view,
+        )

hapic/static/swaggerui/spec.yml

@@ -1,94 +0,0 @@
-definitions:
-  DefaultErrorBuilder:
-    properties:
-      code:
-        type: string
-        x-nullable: true
-      details:
-        type: object
-      message:
-        type: string
-    required:
-    - message
-    type: object
-  HelloJsonSchema:
-    properties:
-      color:
-        minLength: 3
-        type: string
-    required:
-    - color
-    type: object
-  HelloResponseSchema:
-    properties:
-      color:
-        type: string
-      name:
-        type: string
-      sentence:
-        type: string
-    required:
-    - name
-    - sentence
-    type: object
-info:
-  description: ''
-  title: ''
-  version: 1.0.0
-parameters: {}
-paths:
-  /hello/{name}:
-    get:
-      description: "my endpoint hello\n        ---\n        get:\n            description:\
-        \ my description\n            parameters:\n                - in: \"path\"\n\
-        \                  description: \"hello\"\n                  name: \"name\"\
-        \n                  type: \"string\"\n            responses:\n           \
-        \     200:\n                    description: A pet to be returned\n      \
-        \              schema: HelloResponseSchema"
-      parameters:
-      - in: path
-        name: name
-        required: true
-        type: string
-      - in: query
-        name: alive
-        required: false
-        type: boolean
-      responses:
-        '200':
-          description: '200'
-          schema:
-            $ref: '#/definitions/HelloResponseSchema'
-        '400':
-          description: '400'
-          schema:
-            $ref: '#/definitions/DefaultErrorBuilder'
-    post:
-      parameters:
-      - in: body
-        name: body
-        schema:
-          $ref: '#/definitions/HelloJsonSchema'
-      - in: path
-        name: name
-        required: true
-        type: string
-      responses:
-        '200':
-          description: '200'
-          schema:
-            $ref: '#/definitions/HelloResponseSchema'
-  /hello3/{name}:
-    get:
-      parameters:
-      - in: path
-        name: name
-        required: true
-        type: string
-      responses:
-        '200':
-          description: '200'
-          schema:
-            $ref: '#/definitions/HelloResponseSchema'
-swagger: '2.0'
-tags: []