Exposing API Documentation Using Flask and Swagger

Question

I have build a small service with flask and already wrote a swagger yaml file to describe it's API. How can I expose the swagger file through the flask app?

I didn't mean to expose the file itself (send_from_directory) but to create new endpoint that will show it as swagger-ui (interactive, if possible)

score 3 · Answer 1 · answered Sep 16 '16 at 12:59

OK, this is what I did.

I used flasgger to and wrap my app with flasgger.Swagger. than I added 2 endpoints:

/_api serves the YAML file (with send_from_directory)
/api redirects to the flasgger api /apidocs/index.html?url=/api I'm sure it can be done better, but I failed to find it.

github: https://github.com/eplaut/python-butler/blob/master/butler/butler.py#L119

score 2 · Answer 2 · answered Jun 05 '17 at 13:47

2

You can use Flasgger, a Flask extension that wraps Swagger UI for Flask http://github.com/rochacbruno/flasgger

answered Jun 05 '17 at 13:47

Bruno Rocha - rochacbruno

7,262
5
24
31

score 0 · Answer 3 · edited Mar 16 '21 at 10:10

0

There are three ways of doing it:

via Restful-Api (Api.doc)
via getting swagger templates
via registering blueprints (from flask-swagger-ui or smth).

edited Mar 16 '21 at 10:10

Tomerikoo

15,737
15
35
52

answered Mar 16 '21 at 08:54

adekability

37
3

Exposing API Documentation Using Flask and Swagger

3 Answers3