fix fake_api functional test with title and description

example/fake_api/bottle_api.py

@@ -107,7 +107,12 @@ if __name__ == "__main__":
     controllers.bind(app)
     hapic.set_context(BottleContext(app))
     time.sleep(1)
-    s = json.dumps(hapic.generate_doc())
+    s = json.dumps(
+        hapic.generate_doc(
+            title='Fake API',
+            description='just an example of hapic API'
+        )
+    )
     time.sleep(1)
     # print swagger doc
     print(s)

example/fake_api/flask_api.py

@@ -115,7 +115,12 @@ if __name__ == "__main__":
     controllers.bind(app)
     hapic.set_context(FlaskContext(app))
     time.sleep(1)
-    s = json.dumps(hapic.generate_doc())
+    s = json.dumps(
+        hapic.generate_doc(
+            title='Fake API',
+            description='just an example of hapic API'
+        )
+    )
     time.sleep(1)
     # print swagger doc
     print(s)

example/fake_api/pyramid_api.py

@@ -118,7 +118,12 @@ if __name__ == "__main__":
     controllers.bind(configurator)
     hapic.set_context(PyramidContext(configurator))
     time.sleep(1)
-    s = json.dumps(hapic.generate_doc())
+    s = json.dumps(
+        hapic.generate_doc(
+            title='Fake API',
+            description='just an example of hapic API'
+        )
+    )
     time.sleep(1)
     # print swagger doc
     print(s)

tests/func/fake_api/common.py

@@ -1,2 +1,2 @@
 from collections import OrderedDict
-SWAGGER_DOC_API = {'paths': OrderedDict([('/about', {'get': {'description': 'General information about this API.', 'responses': {200: {'schema': {'$ref': '#/definitions/AboutResponseSchema'}, 'description': 'HTTPStatus.OK'}}}}), ('/users', {'get': {'description': 'Obtain users list.', 'responses': {200: {'schema': {'$ref': '#/definitions/ListsUserSchema'}, 'description': 'HTTPStatus.OK'}}}}), ('/users/{id}', {'get': {'description': 'Obtain one user', 'responses': {200: {'schema': {'$ref': '#/definitions/UserSchema'}, 'description': 'HTTPStatus.OK'}}, 'parameters': [{'in': 'path', 'name': 'id', 'required': True, 'type': 'integer'}]}, 'delete': {'description': 'delete user', 'responses': {204: {'schema': {'$ref': '#/definitions/NoContentSchema'}, 'description': '204'}}, 'parameters': [{'in': 'path', 'name': 'id', 'required': True, 'type': 'integer'}]}}), ('/users/', {'post': {'description': 'Add new user', 'responses': {200: {'schema': {'$ref': '#/definitions/UserSchema'}, 'description': 'HTTPStatus.OK'}}, 'parameters': [{'in': 'body', 'name': 'body', 'schema': {'$ref': '#/definitions/UserSchema'}}]}})]), 'definitions': {'ListsUserSchema': {'properties': {'pagination': {'$ref': '#/definitions/PaginationSchema'}, 'items': {'type': 'array', 'items': {'$ref': '#/definitions/UserSchema'}}, 'item_nb': {'minimum': 0, 'type': 'integer', 'format': 'int32'}}, 'type': 'object', 'required': ['item_nb']}, 'AboutResponseSchema': {'properties': {'version': {'type': 'string'}, 'datetime': {'type': 'string', 'format': 'date-time'}}, 'type': 'object', 'required': ['datetime', 'version']}, 'NoContentSchema': {'properties': {}, 'type': 'object'}, 'UserSchema': {'properties': {'display_name': {'type': 'string'}, 'first_name': {'type': 'string'}, 'id': {'type': 'integer', 'format': 'int32'}, 'last_name': {'type': 'string'}, 'company': {'type': 'string'}, 'username': {'type': 'string'}, 'email_address': {'type': 'string', 'format': 'email'}}, 'type': 'object', 'required': ['company', 'display_name', 'email_address', 'first_name', 'id', 'last_name', 'username']}, 'PaginationSchema': {'properties': {'last_id': {'type': 'integer', 'format': 'int32'}, 'current_id': {'type': 'integer', 'format': 'int32'}, 'first_id': {'type': 'integer', 'format': 'int32'}}, 'type': 'object', 'required': ['current_id', 'first_id', 'last_id']}}, 'info': {'title': 'Swagger Petstore', 'version': '1.0.0'}, 'tags': [], 'swagger': '2.0', 'parameters': {}}
+SWAGGER_DOC_API = {'paths': OrderedDict([('/about', {'get': {'description': 'General information about this API.', 'responses': {200: {'schema': {'$ref': '#/definitions/AboutResponseSchema'}, 'description': 'HTTPStatus.OK'}}}}), ('/users', {'get': {'description': 'Obtain users list.', 'responses': {200: {'schema': {'$ref': '#/definitions/ListsUserSchema'}, 'description': 'HTTPStatus.OK'}}}}), ('/users/{id}', {'get': {'description': 'Obtain one user', 'responses': {200: {'schema': {'$ref': '#/definitions/UserSchema'}, 'description': 'HTTPStatus.OK'}}, 'parameters': [{'in': 'path', 'name': 'id', 'required': True, 'type': 'integer'}]}, 'delete': {'description': 'delete user', 'responses': {204: {'schema': {'$ref': '#/definitions/NoContentSchema'}, 'description': '204'}}, 'parameters': [{'in': 'path', 'name': 'id', 'required': True, 'type': 'integer'}]}}), ('/users/', {'post': {'description': 'Add new user', 'responses': {200: {'schema': {'$ref': '#/definitions/UserSchema'}, 'description': 'HTTPStatus.OK'}}, 'parameters': [{'in': 'body', 'name': 'body', 'schema': {'$ref': '#/definitions/UserSchema'}}]}})]), 'definitions': {'ListsUserSchema': {'properties': {'pagination': {'$ref': '#/definitions/PaginationSchema'}, 'items': {'type': 'array', 'items': {'$ref': '#/definitions/UserSchema'}}, 'item_nb': {'minimum': 0, 'type': 'integer', 'format': 'int32'}}, 'type': 'object', 'required': ['item_nb']}, 'AboutResponseSchema': {'properties': {'version': {'type': 'string'}, 'datetime': {'type': 'string', 'format': 'date-time'}}, 'type': 'object', 'required': ['datetime', 'version']}, 'NoContentSchema': {'properties': {}, 'type': 'object'}, 'UserSchema': {'properties': {'display_name': {'type': 'string'}, 'first_name': {'type': 'string'}, 'id': {'type': 'integer', 'format': 'int32'}, 'last_name': {'type': 'string'}, 'company': {'type': 'string'}, 'username': {'type': 'string'}, 'email_address': {'type': 'string', 'format': 'email'}}, 'type': 'object', 'required': ['company', 'display_name', 'email_address', 'first_name', 'id', 'last_name', 'username']}, 'PaginationSchema': {'properties': {'last_id': {'type': 'integer', 'format': 'int32'}, 'current_id': {'type': 'integer', 'format': 'int32'}, 'first_id': {'type': 'integer', 'format': 'int32'}}, 'type': 'object', 'required': ['current_id', 'first_id', 'last_id']}}, 'info': {'title': 'Fake API','description':'just an example of hapic API','version': '1.0.0'}, 'tags': [], 'swagger': '2.0', 'parameters': {}}

tests/func/fake_api/test_bottle.py

@@ -14,7 +14,10 @@ def test_func_bottle_fake_api():
 
     hapic.set_context(BottleContext(bottle_app))
     app = TestApp(bottle_app)
-    doc = hapic.generate_doc()
+    doc = hapic.generate_doc(
+        title='Fake API',
+        description='just an example of hapic API'
+    )
 
     assert doc == SWAGGER_DOC_API
     resp = app.get('/about')

tests/func/fake_api/test_flask.py

@@ -12,7 +12,10 @@ def test_func_flask_fake_api():
     controllers.bind(flask_app)
     hapic.set_context(FlaskContext(flask_app))
     app = TestApp(flask_app)
-    doc = hapic.generate_doc()
+    doc =  hapic.generate_doc(
+        title='Fake API',
+        description='just an example of hapic API'
+    )
 
     assert doc == SWAGGER_DOC_API
     resp = app.get('/about')

tests/func/fake_api/test_pyramid.py

@@ -13,7 +13,10 @@ def test_func_pyramid_fake_api_doc():
     controllers.bind(configurator)
     hapic.set_context(PyramidContext(configurator))
     app = TestApp(configurator.make_wsgi_app())
-    doc = hapic.generate_doc()
+    doc = hapic.generate_doc(
+        title='Fake API',
+        description='just an example of hapic API'
+    )
 
     assert doc == SWAGGER_DOC_API
     resp = app.get('/about')