Merge branch 'ag/api' into futur

1 files changed, 39 insertions, 0 deletions

diff --git a/Documentation/usage/installation.rst b/Documentation/usage/installation.rst
index 4dde4f4..92b3c5d 100644
--- a/Documentation/usage/installation.rst
+++ b/Documentation/usage/installation.rst
@@ -12,6 +12,10 @@ suivantes :
  - BeautifulSoup4_ et LXML_, pour parser les emplois du temps en XML
  - icalendar_, pour générer des fichiers ICS_.
 
+Une dépendance est optionnelle :
+
+ - `Django REST Framework`_, pour l’:doc:`API REST <rest>`.
+
 celcatsanitizer requiert Python 3.4 au minimum, et marche avec les
 versions 3.5 et 3.6. Les versions antérieures de Python 3 n’ont pas
 étés testées, et les versions supérieures devraient fonctionner sans
@@ -31,6 +35,7 @@ Pour l’instant, l’installation doit passer par git_.
 .. _LXML: https://lxml.de/
 .. _icalendar: https://icalendar.readthedocs.io/en/latest/
 .. _ICS: https://fr.wikipedia.org/wiki/ICalendar
+.. _Django REST Framework: https://www.django-rest-framework.org/
 .. _PostgreSQL: https://www.postgresql.org/
 .. _psycopg2: http://initd.org/psycopg/docs/install.html
 .. _git: https://git-scm.com/
@@ -95,6 +100,13 @@ psycopg2 :
 
     $ pip install psycopg2-binary
 
+Si vous souhaitez activer l’API REST, vous devez installer le module
+Django Rest Framework :
+
+.. code:: shell
+
+   $ pip install djangorestframework
+
 Si vous êtes en production, il est recommandé d’utiliser gunicorn_ si
 vous n’utilisez pas le serveur Apache. Installez-le de la même
 manière :
@@ -232,6 +244,33 @@ Ce paramètre est **optionnel**.
 
 __ https://docs.djangoproject.com/fr/2.0/topics/i18n/
 
+Activation de l’API REST et configuration de Django Rest Framework
+``````````````````````````````````````````````````````````````````
+L’API REST permet à des outils tiers d’accéder facilement aux données
+gérées par celcatsanitizer.  Elle est optionnelle, et est basée sur
+Django Rest Framework.  :doc:`Plus d’informations sur la page de l’API
+REST <rest>`.
+
+Si vous souhaitez l’activer, vous devez d’abord avoir installé Django
+REST Framework, puis mettre la variable ``CS_ENABLE_API`` à ``True``.
+
+.. code:: Python
+
+   CS_ENABLE_API = True
+
+Ajoutez ensuite la chaîne de caractère ``rest_framework`` à la liste
+``INSTALLED_APPS``.
+
+Libre à vous de configurer DRF de la manière dont vous le souhaitez.
+`Les différents paramètres sont accessibles ici`__.  Les plus
+intéressants sont ``DEFAULT_PERMISSION_CLASSES``,
+``DEFAULT_RENDERER_CLASSES``, ``DEFAULT_PAGINATION_CLASS`` et
+``PAGE_SIZE``.
+
+__ https://www.django-rest-framework.org/api-guide/settings/
+
+Cette étape est **optionnelle**.
+
 ``urls.py``
 -----------
 Dans le fichier ``celcatsanitizer/urls.py``, importez la fonction