Skip to content

Commit 6e975f7

Browse files
committed
Enhance README
1 parent 7b75f5a commit 6e975f7

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.rst

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@
1111
Flask-REST-JSONAPI
1212
##################
1313

14-
Flask-REST-JSONAPI is a flask extension to build REST api. It combines the power of `Flask-Restless <https://flask-restless.readthedocs.io/en/stable/>`_ and the flexibility of `Flask-RESTful <http://flask-restful-cn.readthedocs.io/en/0.3.5/a>`_ around a strong specification `JSONAPI 1.0 <http://jsonapi.org/>`_. This framework is design to quickly build REST api and to fit the complexity of real life projects with legacy data and multiple data storages.
14+
Flask-REST-JSONAPI is a flask extension for building REST APIs. It combines the power of `Flask-Restless <https://flask-restless.readthedocs.io/en/stable/>`_ and the flexibility of `Flask-RESTful <http://flask-restful-cn.readthedocs.io/en/0.3.5/a>`_ 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.
1515

1616
Install
1717
=======
1818

1919
pip install Flask-REST-JSONAPI
2020

21-
A minimal api
21+
A minimal API
2222
=============
2323

2424
.. code-block:: python
@@ -67,19 +67,19 @@ A minimal api
6767
data_layer = {'session': db.session,
6868
'model': Person}
6969
70-
# Create the api
70+
# Create the API object
7171
api = Api(app)
7272
api.route(PersonList, 'person_list', '/persons')
7373
api.route(PersonDetail, 'person_detail', '/persons/<int:id>')
7474
75-
# start the flask loop
75+
# Start the flask loop
7676
if __name__ == '__main__':
7777
app.run()
7878
79-
This example provides this api:
79+
This example provides the following API structure:
8080

8181
======================== ====== ============= ===========================
82-
url method endpoint Usage
82+
URL method endpoint Usage
8383
======================== ====== ============= ===========================
8484
/persons GET person_list Get a collection of persons
8585
/persons POST person_list Create a person
@@ -91,18 +91,18 @@ url method endpoint Usage
9191
Flask-REST-JSONAPI vs `Flask-RESTful <http://flask-restful-cn.readthedocs.io/en/0.3.5/a>`_
9292
==========================================================================================
9393

94-
* Instead of Flask-RESTful, Flask-REST-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.
95-
* Flask-REST-JSONAPI is as flexible as Flask-RESTful. You can rewrite every default methods implementation to make custom work like distributing object creation.
94+
* Instead of Flask-RESTful, Flask-REST-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.
95+
* Flask-REST-JSONAPI is as flexible as Flask-RESTful. You can rewrite every default method implementation to make custom work like distributing object creation.
9696

9797
Flask-REST-JSONAPI vs `Flask-Restless <https://flask-restless.readthedocs.io/en/stable/>`_
9898
==========================================================================================
9999

100-
* Flask-REST-JSONAPI is a real implementation of JSONAPI 1.0 specification. So instead of Flask-Restless, Flask-REST-JSONAPI force 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.
101-
* Instead of Flask-Restless, Flask-REST-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 storage.
102-
* Like i said previously, Flask-REST-JSONAPI is a real implementation of JSONAPI 1.0 specification. So instead of Flask-Restless you can manage relationships via REST. You can create dedicated url to create a CRUD api to manage relationships.
103-
* Plus Flask-REST-JSONAPI helps you to design your application with strong separation between resource definition (schemas), resource management (resource class) and route definition to get a great organization of your source code.
104-
* Instead of Flask-Restless, Flask-REST-JSONAPI is highly customizable. For example you can entirely customize you urls, define multiple urls for the same resource manager,control serialization parameters of each methods and lot of very useful parameters.
105-
* Finally instead of Flask-Restless, Flask-REST-JSONAPI provides a great error handling system according to JSONAPI 1.0. Plus the exception handling system really helps the api developer to quickly find missing resources requirements.
100+
* Flask-REST-JSONAPI is a real implementation of JSONAPI 1.0 specification. So instead of Flask-Restless, Flask-REST-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.
101+
* Instead of Flask-Restless, Flask-REST-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.
102+
* Like I said previously, Flask-REST-JSONAPI is a real implementation of JSONAPI 1.0 specification. So instead of Flask-Restless you can manage relationships via REST. You can create dedicated URL to create a CRUD API to manage relationships.
103+
* plus Flask-REST-JSONAPI helps you to design your application with strong separation between resource definition (schemas), resource management (resource class) and route definition to get a great organization of your source code.
104+
* instead of Flask-Restless, Flask-REST-JSONAPI is highly customizable. For example you can entirely customize your URLs, define multiple URLs for the same resource manager, control serialization parameters of each method and lots of very useful parameters.
105+
* Finally instead of Flask-Restless, Flask-REST-JSONAPI provides a great error handling system according to JSONAPI 1.0. Plus the exception handling system really helps the API developer to quickly find missing resources requirements.
106106

107107
Documentation
108108
=============
@@ -112,4 +112,4 @@ Documentation available here: http://flask-rest-jsonapi.readthedocs.io/en/latest
112112
Thanks
113113
======
114114

115-
Flask, marshmallow, marshmallow_jsonapi, sqlalchemy, Flask-RESTful and Flask-Restless are awesome project. These librairies give me inspiration to create Flask-REST-JSONAPI so huge thanks to authors and contributors.
115+
Flask, marshmallow, marshmallow_jsonapi, sqlalchemy, Flask-RESTful and Flask-Restless are awesome projects. These libraries gave me inspiration to create Flask-REST-JSONAPI, so huge thanks to authors and contributors.

0 commit comments

Comments
 (0)