You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.rst
+12-4
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,12 @@
12
12
Flask-COMBO-JSONAPI
13
13
###################
14
14
15
-
Flask-COMBO-JSONAPI is a flask extension for building REST APIs. It combines the power of `Flask-Restless <https://flask-restless.readthedocs.io/>`_ and the flexibility of `Flask-RESTful <https://flask-restful.readthedocs.io/>`_ around a strong specification `JSONAPI 1.0 <http://jsonapi.org/>`_. This framework is designed to quickly build REST APIs and fit the complexity of real life projects with legacy data and multiple data storages.
15
+
Flask-COMBO-JSONAPI is a flask extension for building REST APIs.
16
+
It combines the power of `Flask-Restless`_
17
+
and the flexibility of `Flask-RESTful`_
18
+
around a strong specification `JSONAPI 1.0 <http://jsonapi.org/>`_.
19
+
This framework is designed to quickly build REST APIs and fit the complexity
20
+
of real life projects with legacy data and multiple data storages.
16
21
17
22
The main goal is to make it flexible using `plugin system <https://combojsonapi.readthedocs.io/>`_
18
23
@@ -119,14 +124,14 @@ URL method endpoint Usage
119
124
`More detailed example in the docs <https://flask-combo-jsonapi.readthedocs.io/en/stable/minimal_api_example.html>`_
120
125
121
126
122
-
Flask-COMBO-JSONAPI vs `Flask-RESTful<https://flask-restful.readthedocs.io/en/latest/>`_
* In contrast to Flask-RESTful, Flask-COMBO-JSONAPI provides a default implementation of get, post, patch and delete methods around a strong specification JSONAPI 1.0. Thanks to this you can build REST API very quickly.
126
131
* Flask-COMBO-JSONAPI is as flexible as Flask-RESTful. You can rewrite every default method implementation to make custom work like distributing object creation.
127
132
128
-
Flask-COMBO-JSONAPI vs `Flask-Restless<https://flask-restless.readthedocs.io/en/stable/>`_
* Flask-COMBO-JSONAPI is a real implementation of JSONAPI 1.0 specification. So in contrast to Flask-Restless, Flask-COMBO-JSONAPI forces you to create a real logical abstration over your data models with `Marshmallow <https://marshmallow.readthedocs.io/en/latest/>`_. So you can create complex resource over your data.
132
137
* In contrast to Flask-Restless, Flask-COMBO-JSONAPI can use any ORM or data storage through the data layer concept, not only `SQLAlchemy <http://www.sqlalchemy.org/>`_. A data layer is a CRUD interface between your resource and one or more data storage so you can fetch data from any data storage of your choice or create resource that use multiple data storages.
@@ -144,3 +149,6 @@ Thanks
144
149
======
145
150
146
151
Flask, marshmallow, marshmallow_jsonapi, sqlalchemy, Flask-RESTful and Flask-Restless are awesome projects. These libraries gave me inspiration to create Flask-COMBO-JSONAPI, so huge thanks to authors and contributors.
0 commit comments