Skip to content

Commit 2cb5bf7

Browse files
committedSep 1, 2021
Update readme (fix)
1 parent 1ca12a6 commit 2cb5bf7

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed
 

‎README.rst

+12-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,12 @@
1212
Flask-COMBO-JSONAPI
1313
###################
1414

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.
1621

1722
The main goal is to make it flexible using `plugin system <https://combojsonapi.readthedocs.io/>`_
1823

@@ -119,14 +124,14 @@ URL method endpoint Usage
119124
`More detailed example in the docs <https://flask-combo-jsonapi.readthedocs.io/en/stable/minimal_api_example.html>`_
120125

121126

122-
Flask-COMBO-JSONAPI vs `Flask-RESTful <https://flask-restful.readthedocs.io/en/latest/>`_
127+
Flask-COMBO-JSONAPI vs `Flask-RESTful`_
123128
==========================================================================================
124129

125130
* 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.
126131
* Flask-COMBO-JSONAPI is as flexible as Flask-RESTful. You can rewrite every default method implementation to make custom work like distributing object creation.
127132

128-
Flask-COMBO-JSONAPI vs `Flask-Restless <https://flask-restless.readthedocs.io/en/stable/>`_
129-
==========================================================================================
133+
Flask-COMBO-JSONAPI vs `Flask-Restless`_
134+
===========================================================================================
130135

131136
* 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.
132137
* 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
144149
======
145150

146151
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.
152+
153+
.. _`Flask-Restless`: https://flask-restless.readthedocs.io/
154+
.. _`Flask-RESTful`: https://flask-restful.readthedocs.io/

0 commit comments

Comments
 (0)
Please sign in to comment.