Removed built-in OpenAPI support (#1288)

* Removed built-in OpenAPI support

* Removed django filter schema methods

Author: sliverc

CHANGELOG.md

@@ -26,7 +26,7 @@ any parts of the framework not mentioned in the documentation should generally b
 * Removed support for Python 3.8.
 * Removed support for Django REST framework 3.14.
 * Removed support for Django 5.0.
-
+* Removed built-in support for generating OpenAPI schema. Use [drf-spectacular-json-api](https://github.com/jokiefer/drf-spectacular-json-api/) instead.
 
 ## [7.1.0] - 2024-10-25
 

README.rst

@@ -114,7 +114,6 @@ Install using ``pip``...
     $ # for optional package integrations
     $ pip install djangorestframework-jsonapi['django-filter']
     $ pip install djangorestframework-jsonapi['django-polymorphic']
-    $ pip install djangorestframework-jsonapi['openapi']
 
 
 or from source...
@@ -156,8 +155,6 @@ installed and activated:
 Browse to
 
 * http://localhost:8000 for the list of available collections (in a non-JSON:API format!),
-* http://localhost:8000/swagger-ui/ for a Swagger user interface to the dynamic schema view, or
-* http://localhost:8000/openapi for the schema view's OpenAPI specification document.
 
 
 -----

docs/getting-started.md

@@ -69,7 +69,6 @@ Install using `pip`...
     # for optional package integrations
     pip install djangorestframework-jsonapi['django-filter']
     pip install djangorestframework-jsonapi['django-polymorphic']
-    pip install djangorestframework-jsonapi['openapi']
 
 or from source...
 
@@ -100,8 +99,6 @@ and add `rest_framework_json_api` to your `INSTALLED_APPS` setting below `rest_f
 
 Browse to
 * [http://localhost:8000](http://localhost:8000) for the list of available collections (in a non-JSON:API format!),
-* [http://localhost:8000/swagger-ui/](http://localhost:8000/swagger-ui/) for a Swagger user interface to the dynamic schema view, or
-* [http://localhost:8000/openapi](http://localhost:8000/openapi) for the schema view's OpenAPI specification document.
 
 ## Running Tests
 

docs/usage.md

@@ -1054,139 +1054,6 @@ The `prefetch_related` case will issue 4 queries, but they will be small and fas
 ### Errors
 -->
 
-## Generating an OpenAPI Specification (OAS) 3.0 schema document
-
-DRF has a [OAS schema functionality](https://www.django-rest-framework.org/api-guide/schemas/) to generate an
-[OAS 3.0 schema](https://www.openapis.org/) as a YAML or JSON file.
-
-DJA extends DRF's schema support to generate an OAS schema in the JSON:API format.
-
----
-
-**Deprecation notice:**
-
-REST framework's built-in support for generating OpenAPI schemas is
-**deprecated** in favor of 3rd party packages that can provide this
-functionality instead. Therefore we have also deprecated the schema support in
-Django REST framework JSON:API. The built-in support will be retired over the
-next releases.
-
-As a full-fledged replacement, we recommend the [drf-spectacular-json-api] package.
-
----
-
-### AutoSchema Settings
-
-In order to produce an OAS schema that properly represents the JSON:API structure
-you have to either add a `schema` attribute to each view class or set the `REST_FRAMEWORK['DEFAULT_SCHEMA_CLASS']`
-to DJA's version of AutoSchema.
-
-#### View-based
-
-```python
-from rest_framework_json_api.schemas.openapi import AutoSchema
-
-class MyViewset(ModelViewSet):
-    schema = AutoSchema
-    ...
-```
-
-#### Default schema class
-
-```python
-REST_FRAMEWORK = {
-    # ...
-    'DEFAULT_SCHEMA_CLASS': 'rest_framework_json_api.schemas.openapi.AutoSchema',
-}
-```
-
-### Adding additional OAS schema content
-
-You can extend the OAS schema document by subclassing
-[`SchemaGenerator`](https://www.django-rest-framework.org/api-guide/schemas/#schemagenerator)
-and extending `get_schema`.
-
-
-Here's an example that adds OAS `info` and `servers` objects.
-
-```python
-from rest_framework_json_api.schemas.openapi import SchemaGenerator as JSONAPISchemaGenerator
-
-
-class MySchemaGenerator(JSONAPISchemaGenerator):
-    """
-    Describe my OAS schema info in detail (overriding what DRF put in) and list the servers where it can be found.
-    """
-    def get_schema(self, request, public):
-        schema = super().get_schema(request, public)
-        schema['info'] = {
-            'version': '1.0',
-            'title': 'my demo API',
-            'description': 'A demonstration of [OAS 3.0](https://www.openapis.org)',
-            'contact': {
-                'name': 'my name'
-            },
-            'license': {
-                'name': 'BSD 2 clause',
-                'url': 'https://github.com/django-json-api/django-rest-framework-json-api/blob/main/LICENSE',
-            }
-        }
-        schema['servers'] = [
-            {'url': 'http://localhost/v1', 'description': 'local docker'},
-            {'url': 'http://localhost:8000/v1', 'description': 'local dev'},
-            {'url': 'https://api.example.com/v1', 'description': 'demo server'},
-            {'url': '{serverURL}', 'description': 'provide your server URL',
-             'variables': {'serverURL': {'default': 'http://localhost:8000/v1'}}}
-        ]
-        return schema
-```
-
-### Generate a Static Schema on Command Line
-
-See [DRF documentation for generateschema](https://www.django-rest-framework.org/api-guide/schemas/#generating-a-static-schema-with-the-generateschema-management-command)
-To generate a static OAS schema document, using the `generateschema` management command, you **must override DRF's default** `generator_class` with the DJA-specific version:
-
-```text
-$ ./manage.py generateschema --generator_class rest_framework_json_api.schemas.openapi.SchemaGenerator
-```
-
-You can then use any number of OAS tools such as
-[swagger-ui-watcher](https://www.npmjs.com/package/swagger-ui-watcher)
-to render the schema:
-```text
-$ swagger-ui-watcher myschema.yaml
-```
-
-Note: Swagger-ui-watcher will complain that "DELETE operations cannot have a requestBody"
-but it will still work. This [error](https://github.com/OAI/OpenAPI-Specification/pull/2117)
-in the OAS specification will be fixed when [OAS 3.1.0](https://www.openapis.org/blog/2020/06/18/openapi-3-1-0-rc0-its-here)
-is published.
-
-([swagger-ui](https://www.npmjs.com/package/swagger-ui) will work silently.)
-
-### Generate a Dynamic Schema in a View
-
-See [DRF documentation for a Dynamic Schema](https://www.django-rest-framework.org/api-guide/schemas/#generating-a-dynamic-schema-with-schemaview).
-
-```python
-from rest_framework.schemas import get_schema_view
-
-urlpatterns = [
-    ...
-    path('openapi', get_schema_view(
-        title="Example API",
-        description="API for all things …",
-        version="1.0.0",
-        generator_class=MySchemaGenerator,
-    ), name='openapi-schema'),
-    path('swagger-ui/', TemplateView.as_view(
-        template_name='swagger-ui.html',
-        extra_context={'schema_url': 'openapi-schema'}
-    ), name='swagger-ui'),
-    ...
-]
-```
-
 ## Third Party Packages
 
 ### About Third Party Packages

example/settings/dev.py

@@ -83,7 +83,6 @@
         "rest_framework_json_api.renderers.BrowsableAPIRenderer",
     ),
     "DEFAULT_METADATA_CLASS": "rest_framework_json_api.metadata.JSONAPIMetadata",
-    "DEFAULT_SCHEMA_CLASS": "rest_framework_json_api.schemas.openapi.AutoSchema",
     "DEFAULT_FILTER_BACKENDS": (
         "rest_framework_json_api.filters.OrderingFilter",
         "rest_framework_json_api.django_filters.DjangoFilterBackend",