aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
blob: a6bdaab801bc852475b19e97c95061a99b3aa88d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
FlyWheel Documentation
======================

This is the online documentation for FlyWheel - A REST framework for Django. 

Some of FlyWheel's features:

* Clean, simple, class-based views for Resources.
* Support for ModelResources with nice default implementations and input validation.
* Automatically provides a browse-able self-documenting API.
* Pluggable Emitters, Parsers and Authenticators - Easy to customise.
* Content type negotiation using Accept headers.
* Optional support for forms as input validation.
* Modular architecture - Easy to extend and modify.

.. toctree::
  :maxdepth: 1

  resource
  modelresource
  emitters
  parsers
  authenticators
  response


Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`