Add bottle_fake_api example

example/fake_api/bottle_api.py

@@ -0,0 +1,121 @@
+# -*- coding: utf-8 -*-
+import json
+from http import HTTPStatus
+
+import bottle
+import time
+from datetime import datetime
+import hapic
+from example.fake_api.schema import *
+from hapic.data import HapicData
+
+
+class NoContentException(Exception):
+    pass
+
+
+class Controllers(object):
+    @hapic.with_api_doc()
+    @hapic.output_body(AboutResponseSchema())
+    def about(self):
+        """
+        General information about this API.
+        """
+        return {
+            'version': '1.2.3',
+            'datetime': datetime.now(),
+        }
+
+    @hapic.with_api_doc()
+    @hapic.output_body(ListsUserSchema())
+    def get_users(self):
+        """
+        Obtain users list.
+        """
+        return {
+            'item_nb': 1,
+            'items': [
+                {
+                    'id': 4,
+                    'username': 'some_user',
+                    'display_name': 'Damien Accorsi',
+                    'company': 'Algoo',
+                },
+            ],
+            'pagination': {
+                'first_id': 0,
+                'last_id': 5,
+                'current_id': 0,
+            }
+        }
+
+    @hapic.with_api_doc()
+    @hapic.input_path(UserPathSchema())
+    @hapic.output_body(UserSchema())
+    def get_user(self, id, hapic_data: HapicData):
+        """
+        Obtain one user
+        """
+        return {
+             'id': 4,
+             'username': 'some_user',
+             'email_address': 'some.user@hapic.com',
+             'first_name': 'Damien',
+             'last_name': 'Accorsi',
+             'display_name': 'Damien Accorsi',
+             'company': 'Algoo',
+        }
+
+    @hapic.with_api_doc()
+    # TODO - G.M - 2017-12-5 - Support input_forms ?
+    # TODO - G.M - 2017-12-5 - Support exclude, only ?
+    @hapic.input_body(UserSchema(exclude=('id',)))
+    @hapic.output_body(UserSchema())
+    def add_user(self, hapic_data: HapicData):
+        """
+        Add new user
+        """
+        return {
+             'id': 4,
+             'username': 'some_user',
+             'email_address': 'some.user@hapic.com',
+             'first_name': 'Damien',
+             'last_name': 'Accorsi',
+             'display_name': 'Damien Accorsi',
+             'company': 'Algoo',
+        }
+
+    @hapic.with_api_doc()
+    @hapic.handle_exception(NoContentException, http_code=HTTPStatus.NO_CONTENT)
+    @hapic.input_path(UserPathSchema())
+    def del_user(self, id, hapic_data: HapicData):
+        """
+        delete user
+        """
+
+        # TODO - G.M - 2017-12-05 - Add better
+        #  way to doc response of this function, using response object ?
+        # return bottle.Response(
+        #     status=204,
+        # )
+        raise NoContentException
+
+    def bind(self, app:bottle.Bottle):
+        app.route('/about', callback=self.about)
+        app.route('/users', callback=self.get_users)
+        app.route('/users/<id>', callback=self.get_user)
+        app.route('/users/', callback=self.add_user,  method='POST')
+        app.route('/users/<id>', callback=self.del_user, method='DELETE')
+
+
+app = bottle.Bottle()
+controllers = Controllers()
+controllers.bind(app)
+hapic.set_context(hapic.ext.bottle.BottleContext(app))
+time.sleep(1)
+s = json.dumps(hapic.generate_doc())
+time.sleep(1)
+# print swagger doc
+print(s)
+# Run app
+app.run(host='localhost', port=8080, debug=True)

example/fake_api/schema.py

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+import marshmallow
+
+
+class AboutResponseSchema(marshmallow.Schema):
+    version = marshmallow.fields.String(required=True,)
+    datetime = marshmallow.fields.DateTime(required=True)
+
+
+class UserPathSchema(marshmallow.Schema):
+    id = marshmallow.fields.Int(
+        required=True,
+        validate=marshmallow.validate.Range(min=1),
+    )
+
+
+class UserSchema(marshmallow.Schema):
+    id = marshmallow.fields.Int(required=True)
+    username = marshmallow.fields.String(
+        required=True,
+        validate = marshmallow.validate.Regexp(regex='[\w-]+'),
+    )
+    email_address = marshmallow.fields.Email(required=True)
+    first_name = marshmallow.fields.String(required=True)
+    last_name = marshmallow.fields.String(required=True)
+    display_name = marshmallow.fields.String(required=True)
+    company = marshmallow.fields.String(required=True)
+
+
+class PaginationSchema(marshmallow.Schema):
+    first_id = marshmallow.fields.Int(required=True)
+    last_id = marshmallow.fields.Int(required=True)
+    current_id = marshmallow.fields.Int(required=True)
+
+
+class ListsUserSchema(marshmallow.Schema):
+    item_nb = marshmallow.fields.Int(
+        required=True,
+        validate=marshmallow.validate.Range(min=0)
+    )
+    items = marshmallow.fields.Nested(
+        UserSchema,
+        many=True,
+        only=['id', 'username', 'display_name', 'company']
+    )
+    # TODO - G.M - 2017-12-05 - Fix nested schema import into doc !
+    # Can't add doc for nested Schema properly
+    # When schema item isn't added through their own method
+    # Ex : Pagination Schema doesn't work here but UserSchema is ok.
+    pagination = {
+        'first_id': marshmallow.fields.Int(required=True),
+        'last_id': marshmallow.fields.Int(required=True),
+        'current_id': marshmallow.fields.Int(required=True),
+    }