From 9424bd4c3043bf52326f1aca174bd916147849f1 Mon Sep 17 00:00:00 2001 From: Julien Roy Date: Sat, 23 Nov 2024 01:16:27 -0500 Subject: dev-python/drf-spectacular: new package, add 0.27.2 Signed-off-by: Julien Roy --- dev-python/drf-spectacular/metadata.xml | 53 +++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 dev-python/drf-spectacular/metadata.xml (limited to 'dev-python/drf-spectacular/metadata.xml') diff --git a/dev-python/drf-spectacular/metadata.xml b/dev-python/drf-spectacular/metadata.xml new file mode 100644 index 0000000..685b4bc --- /dev/null +++ b/dev-python/drf-spectacular/metadata.xml @@ -0,0 +1,53 @@ + + + + + Julien Roy + julien@jroy.ca + + +This project has 3 goals: + + Extract as much schema information from DRF as possible. + Provide flexibility to make the schema usable in the real world (not only toy examples). + Generate a schema that works well with the most popular client generators. + +The code is a heavily modified fork of the DRF OpenAPI generator, which is/was lacking all of the below listed features. + +Features + + Serializers modelled as components. (arbitrary nesting and recursion supported) + + @extend_schema decorator for customization of APIView, Viewsets, function-based views, and @action + additional parameters + request/response serializer override (with status codes) + polymorphic responses either manually with PolymorphicProxySerializer helper or via rest_polymorphic's PolymorphicSerializer) + ... and more customization options + + Authentication support (DRF natives included, easily extendable) + Custom serializer class support (easily extendable) + SerializerMethodField() type via type hinting or @extend_schema_field + i18n support + Tags extraction + Request/response/parameter examples + Description extraction from docstrings + Vendor specification extensions (x-*) in info, operations, parameters, components, and security schemes + Sane fallbacks + Sane operation_id naming (based on path) + Schema serving with SpectacularAPIView (Redoc and Swagger-UI views are also available) + Optional input/output serializer component split + Callback operations + OpenAPI 3.1 support (via setting OAS_VERSION) + + + + T. Franzel + tfranzel@gmail.com + + https://github.com/tfranzel/drf-spectacular/issues + https://github.com/tfranzel/drf-spectacular/releases + https://drf-spectacular.readthedocs.io/ + tfranzel/drf-spectacular + drf-spectacular + + -- cgit v1.2.3