https://github.com/klen/flask-restler

Yet another REST library for Flask
https://github.com/klen/flask-restler

Last synced: about 2 months ago
JSON representation

Yet another REST library for Flask

• Host: GitHub
• URL: https://github.com/klen/flask-restler
• Owner: klen
• License: mit
• Created: 2016-03-28T23:39:36.000Z (over 8 years ago)
• Default Branch: develop
• Last Pushed: 2024-04-08T16:11:37.000Z (6 months ago)
• Last Synced: 2024-04-16T02:13:56.713Z (5 months ago)
• Language: Python
• Size: 1.12 MB
• Stars: 14
• Watchers: 4
• Forks: 4
• Open Issues: 7
• Metadata Files:
  • Readme: README.rst
  • Changelog: Changelog
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

• jimsghstars - klen/flask-restler - Yet another REST library for Flask (Python)

README

        
The Flask RESTler

#################

.. _badges:

.. image:: http://img.shields.io/travis/klen/falsk-restler.svg?style=flat-square

    :target: http://travis-ci.org/klen/falsk-restler

    :alt: Build Status

.. image:: http://img.shields.io/pypi/v/flask-restler.svg?style=flat-square

    :target: https://pypi.python.org/pypi/flask-restler

    :alt: Version

.. image:: http://img.shields.io/pypi/dm/flask-restler.svg?style=flat-square

    :target: https://pypi.python.org/pypi/flask-restler

    :alt: Downloads

.. _description:

The Flask RESTler -- Build REST API for Flask_ using Marshmallow_.

Has builded support for SQLAlchemy_, Peewee_ ORM and Pymongo_.

Example "Hello User" with the Flask-resler:

.. code-block:: python

    from flask_restler import Api, Resource

    # flask_restler.Api is subclass of Flask.Blueprint

    api = Api('My awesome API', __name__, url_prefix='/api/v1')

    # flask_restler.Resource is subclass of Flask.views.View

    @api.connect

    class HelloResource(Resource):

        def get(self, resource=None):

            return 'Hello World!'

    # Register with your application

    from your_project import app

    app.register_blueprint(api)

    if __name__ == '__main__':

        app.run()

Run the application and open http://localhost:5000/api/v1/ in your browser.

.. _contents:

.. contents::

Requirements

=============

- python 2.7+,3.4+

.. _installation:

Installation

=============

**Flask-RESTler** should be installed using pip: ::

    pip install flask-restler

.. _usage:

Usage

=====

Docs in progress. Would like to help? Create a PR.

.. _bugtracker:

Bug tracker

===========

If you have any suggestions, bug reports or

annoyances please report them to the issue tracker

at https://github.com/klen/flask-restler/issues

.. _contributing:

Contributing

============

Development of The Flask-restler happens at: https://github.com/klen/flask-restler

Contributors

=============

* `Kirill Klenov `_

.. _license:

License

========

Licensed under a MIT license (See LICENSE)

If you wish to express your appreciation for the project, you are welcome to

send a postcard to: ::

    Kirill Klenov

    pos. Severny 8-3

    MO, Istra, 143500

    Russia

.. _links:

.. _klen: https://github.com/klen

.. _Flask: http://flask.pocoo.org/

.. _Marshmallow: https://marshmallow.readthedocs.org/en/latest/

.. _Peewee: http://docs.peewee-orm.com/en/latest/

.. _SQLAlchemy: http://www.sqlalchemy.org/

.. _Pymongo: https://api.mongodb.com/python/current/