Adds a bit about redoc logo in docs, adds a custom_path_ordering hook, adds ability for configuring hooks from config

docs/settings.rst

@@ -61,5 +61,13 @@ in your project files.
         # available SwaggerUI versions: https://github.com/swagger-api/swagger-ui/releases
         "SWAGGER_UI_DIST": "//unpkg.com/swagger-ui-dist@3.35.1", # default
         "SWAGGER_UI_FAVICON_HREF": settings.STATIC_URL + "your_company_favicon.png", # default is swagger favicon
+
+        # example of adding a redoc logo
+        "EXTENSIONS_INFO": {
+            "x-logo": {
+                "url": "https://blahblah.cloudfront.net/static/img/logo-small.png",
+                "backgroundColor": "#FFFFFF",
+                "altText": "Nice Nice Logo"
+        }
         ...
     }

drf_spectacular/generators.py

@@ -251,7 +251,15 @@ def get_schema(self, request=None, public=False):
             components=self.registry.build(spectacular_settings.APPEND_COMPONENTS),
             version=self.api_version or getattr(request, 'version', None),
         )
-        for hook in spectacular_settings.POSTPROCESSING_HOOKS:
-            result = hook(result=result, generator=self, request=request, public=public)
-
+        try:
+            for hook, config in zip(
+                spectacular_settings.POSTPROCESSING_HOOKS,
+                spectacular_settings.POSTPROCESSING_HOOKS_CONFIGS
+            ):
+                result = hook(result=result, generator=self, request=request, public=public, config=config)
+        except Exception:
+            # default
+            for hook in spectacular_settings.POSTPROCESSING_HOOKS:
+                result = hook(result=result, generator=self, request=request, public=public)
+            pass
         return sanitize_result_object(normalize_result_object(result))

drf_spectacular/hooks.py

@@ -1,5 +1,5 @@
 import re
-from collections import defaultdict
+from collections import OrderedDict, defaultdict
 
 from inflection import camelize
 from rest_framework.settings import api_settings
@@ -10,6 +10,38 @@
 from drf_spectacular.settings import spectacular_settings
 
 
+def custom_path_ordering(result, generator, **kwargs):
+    """
+    spectacular_settings.POSTPROCESSING_HOOKS_CONFIGS
+
+        use a list of strings for the config
+
+    The documentation will order based on the list, and then alphaetically for the rest
+    for example: ['schema', 'ping', 'hello']
+    would show in order 'schema', 'ping', 'hello', paths and then the rest
+    for duplicate endpoints you'll need to be more specific on which path is to be sorted
+    It looks at the full path when checking
+    ['api/schema', 'api/ping', 'api/hello/read', ''api/hello/write']
+    """
+    assert 'config' in kwargs, 'custom_path_ordering hook expected config in kwargs: ' + str(kwargs)
+    assert isinstance(kwargs['config'], list), 'custom_path_ordering hook expected a list of strings'
+    special_ordering = kwargs.get('config')
+    unordered = {}
+    the_rest = []
+    if 'paths' in result:
+        for key, value in result['paths'].items():
+            for x in special_ordering:
+                if x in key:
+                    unordered.update({x: (key, value)})
+                    break
+            else:
+                the_rest.append((key, value))
+        ordered = [unordered[x] for x in special_ordering]
+        result['paths'] = OrderedDict(ordered + the_rest)
+        return result
+    return result
+
+
 def postprocess_schema_enums(result, generator, **kwargs):
     """
     simple replacement of Enum/Choices that globally share the same name and have

drf_spectacular/settings.py

@@ -61,7 +61,19 @@
     # Postprocessing functions that run at the end of schema generation.
     # must satisfy interface result = hook(generator, request, public, result)
     'POSTPROCESSING_HOOKS': [
-        'drf_spectacular.hooks.postprocess_schema_enums'
+        'drf_spectacular.hooks.postprocess_schema_enums',
+        # 'drf_spectacular.hooks.custom_path_ordering',
+        # 'your_module.hooks.something_special',
+
+    ],
+    # must match the number of  entries in POSTPROCESSING_HOOKS
+    # must satisfy interface result = hook(generator, request, public, result, config)
+    # where config matches what your hook is expecting
+    # zip(spectacular_settings.POSTPROCESSING_HOOKS, spectacular_settings.POSTPROCESSING_HOOKS_CONFIGS)
+    'POSTPROCESSING_HOOKS_CONFIGS': [
+        {},  # postprocess_schema_enums
+        # ['schema', 'ping'],  # custom_path_ordering
+        # True,  # something_special
     ],
 
     # Preprocessing functions that run before schema generation.