Django REST Framework 3.9 est sorti
par Makersquad ·
Date de sortie : 18 octobre 2018
Documentation officielle : https://www.django-rest-framework.org/community/release-notes/#39x-series
DRF 3.9 apporte un premier support natif d’OpenAPI : selon l’annonce officielle, il s’agit d’un premier jet, et la dépendance à coreapi doit disparaître progressivement dans les versions suivantes. La version permet aussi de combiner les classes de permission avec des opérateurs, et affiche les actions supplémentaires des ViewSets dans l’API navigable.
Les nouveautés principales
Support natif d’OpenAPI
DRF intègre désormais un premier support d’OpenAPI directement dans le framework. Deux nouveaux renderers encodent les instances coreapi.Document en OpenAPI : OpenAPIRenderer (YAML) et JSONOpenAPIRenderer (JSON). La fonction get_schema_view(...) produit désormais du YAML OpenAPI par défaut, le CoreJSON restant disponible par négociation de contenu.
from rest_framework.schemas import get_schema_view
from rest_framework.renderers import JSONOpenAPIRenderer
schema_view = get_schema_view(
title="Server Monitoring API",
url="https://www.example.org/api/",
renderer_classes=[JSONOpenAPIRenderer],
)
La version ajoute aussi une nouvelle commande de gestion, generateschema, qui permet d’écrire le schéma dans un fichier du dépôt :
python manage.py generateschema --format openapi > schema.yml
Permissions composables avec & et |
C’est la fonctionnalité qui fait plaisir à voir. Jusqu’ici, combiner des classes de permission nécessitait d’en écrire une nouvelle à la main. DRF 3.9 introduit les opérateurs & (ET) et | (OU) pour composer les permissions de façon déclarative.
from rest_framework.permissions import IsAuthenticated, IsAdminUser
from myapp.permissions import ReadOnly
# L'utilisateur doit être authentifié ET (lecture seule OU admin)
permission_classes = [IsAuthenticated & (ReadOnly | IsAdminUser)]
Le code se lit presque comme une règle métier. Pour que cette composition fonctionne, vos classes de permission personnalisées doivent hériter de BasePermission.
Actions supplémentaires visibles dans l’API navigable
Depuis l’introduction du décorateur action en 3.8, les actions supplémentaires définies sur un ViewSet sont accessibles depuis l’API navigable (le rendu HTML par défaut de DRF). Lorsqu’elles existent, un menu déroulant « Extra Actions », filtré selon qu’elles portent sur une instance ou sur la collection, s’affiche.
Support de Django 2.1
DRF 3.9 prend en charge les versions 1.11, 2.0 et 2.1 de Django. Django 2.1 est sorti le 1er août 2018, DRF 3.9 le 18 octobre 2018.
À retenir
DRF 3.9 apporte un premier support natif d’OpenAPI, la composition de permissions avec & et | et l’accès aux actions supplémentaires depuis l’API navigable. Si vous écrivez des classes de permission personnalisées, vérifiez qu’elles héritent de BasePermission.