DJAIO-SWAGGER v0.0.1b

djaio-swagger is an extension for djaio-framework. It replaces the default app.router and generates JSON specification of your API in swagger-format.

INSTALLATION

1. Checkout last version

pip install [email protected]:Sberned/djaio-swagger.git@master#egg=djaio-swagger

2. Config your application build file.

2.1 Add following lines to your settings

CUSTOM_ROUTER = 'djaio_swagger.TransmuteUrlDispatcher'

SWAGGER_APP_INFO = {
    'APP_JSON_ROUTE': '/swagger.json',
    'APP_HTML_ROUTE': '/swagger',
    'APP_INFO':{
        'title': 'MY COOL API',
        'version': '1.0',
        'description': 'Here you can write something from the works of William Shakespeare.',
        'license': {
            'name': 'Apache 2.0',
            'url': 'http://www.apache.org'
        },
        'contact': {
            'name': 'William Shakespeare',
            'url': 'https://Romeo-And-Juliet.net',
            'email': '[email protected]'
        },
        'termsOfService': 'to be or not to be'
    }
}

2.2 After that add djaio_swagger.setup(app) to application init function

def init_app():
   ...
   djaio_swagger.setup(app)
   

HOW TO USE

1. Djaio works with Class-based Views

So, let's write some Class-based View:

 class TestAPIView(JsonView):
 
    get_method = methods.Testmethod()
    post_method = methods.Testmethod()
    put_method = methods.Testmethod()
    delete_method = methods.Testmethod()

Great! But what about swagger? Ok. Djaio-swagger works with IN method params like in get_method. You must write an Input and Output models(use schematics - http://schematics.readthedocs.io/), and set description

It will be looks like:

 class TestAPIView(JsonView):
    get_method = methods.Testmethod(input_model=SomeInModel(), output_model=SomeOutModel()
                                    description="My cool method!")
    post_method = methods.Testmethod()
    put_method = methods.Testmethod()
    delete_method = methods.Testmethod()

Now, navigate your favourite browser or swagger-client to /swagger.json and here you go!