Feat/spectacular (#16)

* Update requirements.in

* Update settings.py-tpl

* Update urls.py-tpl

* Update test_startcmsproject.yml

* Update test_startcmsproject.yml

* Update test_startcmsproject.yml

* Update test_startcmsproject.yml

Author: fsbraun

.github/workflows/test_startcmsproject.yml

@@ -13,11 +13,11 @@ jobs:
       fail-fast: false
       matrix:
         django-version: [
-          '3.2', '4.2',
+          '4.2', '5.2',
         ]
-        python-version: ['3.11']
+        python-version: ['3.13']
         os: [
-          ubuntu-20.04,
+          ubuntu-latest,
         ]
 
     steps:
@@ -29,9 +29,9 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Create project from template
       run: |
-        echo $GITHUB_REF
         python -m venv .venv
         source ./.venv/bin/activate
         python -m pip install --upgrade pip
-        pip install django-cms>=4.1.0rc5
-        djangocms mysite --noinput
+        python -m pip install Django~=${{ matrix.django-version}}
+        python -m pip install django-cms
+        djangocms mysite --noinput --template https://github.com/${{ github.repository }}/archive/${{ github.head_ref || github.ref_name }}.zip

project_name/settings.py-tpl

@@ -65,6 +65,7 @@ INSTALLED_APPS = [
 
     'djangocms_rest',
     'rest_framework',
+    'drf_spectacular',
 ]
 
 MIDDLEWARE = [
@@ -213,3 +214,8 @@ INTERNAL_IPS = [
 
 MEDIA_URL = "media/"
 MEDIA_ROOT = str(BASE_DIR.parent / "media")
+
+# Add default schema for drf-spectacular
+REST_FRAMEWORK = {
+    "DEFAULT_SCHEMA_CLASS": 'drf_spectacular.openapi.AutoSchema',
+}

project_name/urls.py-tpl

@@ -21,8 +21,14 @@ from django.contrib import admin
 from django.urls import include, path
 from django.views.i18n import JavaScriptCatalog
 
+from drf_spectacular.views import SpectacularAPIView, SpectacularSwaggerView
+
+
 urlpatterns = [
-    path('', include('djangocms_rest.urls')),
+    # OpenAPI schema and documentation
+    path('api/schema/', SpectacularAPIView.as_view(), name='schema'),
+    path('api/docs/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),
+    path('api/', include('djangocms_rest.urls')),
 ] + i18n_patterns(
     path('jsi18n/', JavaScriptCatalog.as_view(), name='javascript-catalog'),
     path('admin/', admin.site.urls),

requirements.in

@@ -1,7 +1,9 @@
+git+https://github.com/django-cms/django-cms@release/5.0.x
 djangocms-versioning
 djangocms-alias
 django-filer
 djangocms-text
 djangocms-link
 djangocms-picture
-git+https://github.com/fsbraun/djangocms-rest@main
+git+https://github.com/django-cms/djangocms-rest@main
+drf-spectacular