Corrects copy pasta, fixes error made by copilot ;), adds a templates/swagger-ui.html, and adds to requirements.txt

Author: rgs258

drf_endpoint_examples/urls.py

@@ -30,7 +30,7 @@
     ReviewViewSet,
 )
 
-app_name = "drf-endpoint-examples"
+display_name = "DRF Endpoint Examples"
 
 
 router = routers.DefaultRouter()
@@ -40,22 +40,18 @@
 router.register(r"addresses", AddressViewSet)
 router.register(r"reviews", ReviewViewSet)
 
-schema_url_patterns = [path(f"{app_name}/api/", include(router.urls))]
+schema_url_patterns = [path(f"api/", include(router.urls))]
 
 urlpatterns = [
     path("admin/", admin.site.urls),
     path("api-auth/", include("rest_framework.urls")),
     path("api/", include(router.urls)),
     path(
-        "openapi",
+        "openapi/",
         staff_member_required(
             get_schema_view(
-                title="Data Dictionary",
-                description=(
-                    "Swagger API Documentation for Data Dictionary. See the "
-                    "[Data Dictionary Readme](/data-dictionary/readme) for more "
-                    "information."
-                ),
+                title=display_name,
+                description=f"Swagger API Documentation for {display_name}.",
                 version="1.0.0",
                 patterns=schema_url_patterns,
                 generator_class=AuthSchemaGenerator,
@@ -67,11 +63,11 @@
         "swagger-ui/",
         staff_member_required(
             TemplateView.as_view(
-                template_name="wrds/swagger-ui.html",
+                template_name="swagger-ui.html",
                 extra_context={
-                    "schema_url": "data-dictionary:openapi-schema",
-                    "api_name": "Data Dictionary",
-                    "api_swagger_url": "data-dictionary:swagger-ui",
+                    "schema_url": f"openapi-schema",
+                    "api_name": display_name,
+                    "api_swagger_url": f"swagger-ui",
                 },
             )
         ),

endpoints/serializers.py

@@ -26,4 +26,4 @@ class Meta:
 class ReviewSerializer(serializers.HyperlinkedModelSerializer):
     class Meta:
         model = Review
-        fields = ['customer', 'product', 'rating', 'description']
+        fields = ['customer', 'product', 'rating', 'review']

requirements.txt

@@ -3,3 +3,5 @@ djangorestframework~=3.14.0
 django-filter~=23.3
 drf-api-logger~=1.1.14
 Markdown~=3.5
+PyYAML~=6.0.1
+uritemplate~=4.1.1

templates/swagger-ui.html

@@ -0,0 +1,31 @@
+{% load static %}
+
+{% block extra_head_bottom %}
+	<link rel="stylesheet" type="text/css" href="//unpkg.com/swagger-ui-dist@3/swagger-ui.css"/>
+{% endblock extra_head_bottom %}
+
+
+{% block content %}
+	<div id="swagger-ui"></div>
+	<script src="//unpkg.com/swagger-ui-dist@3/swagger-ui-bundle.js"></script>
+	<script>
+		const ui = SwaggerUIBundle({
+			url: "{% url schema_url %}",
+			dom_id: '#swagger-ui',
+			presets: [
+				SwaggerUIBundle.presets.apis,
+				SwaggerUIBundle.SwaggerUIStandalonePreset
+			],
+			layout: "BaseLayout",
+			defaultModelsExpandDepth: 3,
+			defaultModelExpandDepth: 3,
+			defaultModelRendering: "model",
+			requestInterceptor: (request) => {
+				request.headers['X-CSRFToken'] = "{{ csrf_token }}"
+				return request;
+			}
+		})
+	</script>
+	</body>
+	</html>
+{% endblock content %}