Merge pull request #487 from hinashi/feature/auto_generate/custom_view

Added DRF Spectacular settings for customview

README.md

@@ -363,6 +363,10 @@ If you have any change on API V2, you need to run this command before you build:
 ```
 $ npm run generate:client
 ```
+```
+(For Customview)
+$ npm run generate:custom_client
+```
 
 You can also auto-format .js files with [prettier](https://prettier.io/):
 

airone/settings.py

@@ -1,3 +1,4 @@
+from copy import deepcopy
 from airone.settings_common import Common
 
 
@@ -7,3 +8,8 @@ class Dev(Common):
 
 class Prd(Common):
     pass
+
+
+class DRFSpectacularCustomView(Common):
+    SPECTACULAR_SETTINGS = deepcopy(Common.SPECTACULAR_SETTINGS)
+    SPECTACULAR_SETTINGS['PREPROCESSING_HOOKS'].remove('airone.spectacular.exclude_customview_hook')

airone/settings_common.py

@@ -308,3 +308,10 @@ class Common(Configuration):
         ],
         "PAGE_SIZE": 30,
     }
+
+    SPECTACULAR_SETTINGS = {
+        "PREPROCESSING_HOOKS": [
+            "airone.spectacular.exclude_customview_hook",
+            "airone.spectacular.filter_apiv2_hook",
+        ]
+    }

airone/spectacular.py

@@ -0,0 +1,24 @@
+# These methods are used for filtering API endpoints to generate
+# OpenAPI schema using drf-spectacular.
+# (c.f. https://drf-spectacular.readthedocs.io/en/latest/settings.html)
+
+def exclude_customview_hook(endpoints):
+    """This excludes API endpoints of custom-view's ones. Because it's not always
+    necessary to generage custom-view's OpenAPI schema.
+    """
+    result = []
+    for (path, path_regex, method, callback) in endpoints:
+        if "/custom/" not in path:
+            result.append((path, path_regex, method, callback))
+    return result
+
+
+def filter_apiv2_hook(endpoints):
+    """This excludes API endpoints for AirOne API(v1). React views refer to only
+    AirOne API(v2). So it's not necessary to generate API(v1)'s OpenAPI schema.
+    """
+    result = []
+    for (path, path_regex, method, callback) in endpoints:
+        if "/api/v2/" in path:
+            result.append((path, path_regex, method, callback))
+    return result

frontend/src/apiclient/autogenerated/.openapi-generator/FILES

@@ -1,6 +1,5 @@
 .openapi-generator-ignore
 apis/AclApi.ts
-apis/ApiApi.ts
 apis/EntityApi.ts
 apis/EntryApi.ts
 apis/GroupApi.ts