Large app best practice ? about flask-restful-swagger HOT 5 CLOSED

Repeating the swagger.docs call each time does seem to work but I would discourage that. Mainly bc you're repeating some definitions that you later might want to modify. And you might forget to do so in all files.
I would create a single file with the instantiation of swagger.docs just once and import that file and the instance of docs in all other places.

from flask-restful-swagger.

I'm probably missing something here but as far as each module instantiates a blueprint which is in turn passed to swagger.docs, I don't understand how to use the unique instantiation of swagger.docs.
To follow your advice and avoid repeating the call to swagger.docs, I've put it in a helper function:

def wrap_with_docs(api):
    api = swagger.docs(api, ...)
    return api

which I call in every module:

my_blueprint = Blueprint('my_blueprint', __name__)
api = wrap_with_docs(Api(my_blueprint))

from flask-restful-swagger.

Oh I see your point. I wasn't familiar with the usage of Blueprints within Flask (so far my apps were pretty minimalistic when using Flask). I didn't notice that each Blueprint creates a new api instance.

So indeed your solution of wrapping the call to swagger.docs makes sense.
Sorry for the late response, I was on vacation...

from flask-restful-swagger.

Hi phb95, I know I am coming into this very late, but did you manage to find a way to have the APIs from all of your blueprints appear on one swagger spec.html page?

from flask-restful-swagger.

Hi jonny166,

Yes I did, by calling swagger.docs on each Api object.
Afterwards, I simply followed rantav advice to not repeat the swagger.docs call by wrapping it into a helper function.

Hope this helps.

from flask-restful-swagger.