Skip to content

Commit

Permalink
Add quick description in README
Browse files Browse the repository at this point in the history
  • Loading branch information
lafrech committed Mar 14, 2018
1 parent 7c2d405 commit 0c20fb4
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,28 @@ flask-rest-api
:target: https://www.codacy.com/app/lafrech/flask-rest-api
:alt: Code health

Build a REST API with Flask.
Build a REST API with Flask and marshmallow.

**flask-rest-api** relies on `marshmallow <https://github.com/marshmallow-code/marshmallow>`_, `webargs <https://github.com/sloria/webargs>`_ and `apispec <https://github.com/marshmallow-code/apispec/>`_ to provide a complete REST API framework.

Features
========

- Serialization, deserialization and validation using marshmallow ``Schema``.
- OpenAPI (Swagger) specification automatically generated, and exposed with `ReDoc <https://github.com/Rebilly/ReDoc>`_.
- ETag.
- Pagination.

Install
=======

::

pip install flask-rest-api

flask-rest-api supports Python >= 3.4.

License
=======

MIT licensed. See the `LICENSE <https://github.com/Nobatek/flask-rest-api/blob/master/LICENSE>`_ file for more details.

0 comments on commit 0c20fb4

Please sign in to comment.