File tree Expand file tree Collapse file tree 3 files changed +19
-9
lines changed Expand file tree Collapse file tree 3 files changed +19
-9
lines changed Original file line number Diff line number Diff line change @@ -17,7 +17,7 @@ Documentation
1717The Microservice create a URL to inspect the Swagger documentation of the api in:
1818
1919.. code-block :: bash
20- localhost:5000/[APPLICATION_ROOT]/apidocs /
20+ localhost:5000/[APPLICATION_ROOT]/ui /
2121
22- Our API Rest work with `Flasgger < https ://github.com/rochacbruno/flasgger >`_. You can see Flasgger docs or the official
22+ Our API Rest work with `connexion < http ://connexion.readthedocs.io >`_. You can see connexion docs or the official
2323`Swagger documentation <https://swagger.io/specification/ >`_ to add the syntax to your APIS and create your Swagger docs
Original file line number Diff line number Diff line change @@ -7,11 +7,13 @@ Python Microservices
77
88Stack
99-----
10+ * `connexion <http://connexion.readthedocs.io >`_
1011* `Flask <https://github.com/pallets/flask >`_
1112* `SQLAlchemy <https://www.sqlalchemy.org/ >`_
1213* `Flask-SQLAlchemy <http://flask-sqlalchemy.pocoo.org/2.3/ >`_
13- * `Flasgger <https://github.com/rochacbruno/flasgger >`_
14+ * `Flask-Injector <https://github.com/alecthomas/flask_injector >`_
1415* `Flask-Script <https://flask-script.readthedocs.io/en/latest/ >`_
16+ * `Opentracing <https://github.com/opentracing-contrib/python-flask >`_
1517
1618
1719Content
Original file line number Diff line number Diff line change @@ -23,14 +23,18 @@ You have a project with this structure:
2323 project
2424 ├ __init__.py
2525 ├ config.py
26- ├ views
27- │ ├ __init__.py
28- │ └ views.py
2926 ├ models
3027 │ ├ __init__.py
3128 │ └ models.py
32- └ tests
33- └ test_views.py
29+ ├ swagger
30+ │ └ swagger.yaml
31+ ├ tests
32+ │ └ test_views.py
33+ └views
34+ ├ __init__.py
35+ └ views.py
36+
37+
3438
3539 manager.py
3640----------
@@ -80,6 +84,10 @@ See :doc:`configuration </configuration>` section
8084
8185project/views
8286~~~~~~~~~~~~~
83- use views.py or create your file. You must add after register the view blueprint in `project/views/__init__.py `.
87+ use views.py or create your file.
88+
89+ swagger/swagger.yaml
90+ ~~~~~~~~~~~~~
91+ Use to define your rest behaviour, endpoints and routes. See `connexion <http://connexion.readthedocs.io >`_ docs to how add new views
8492
8593
You can’t perform that action at this time.
0 commit comments