Skip to content

Swagger UI #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
codeguru42 merged 3 commits into from
Mar 3, 2021
+88 −2
Merged

Swagger UI #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
13e5859
Add pyyaml and uritemplate dependencies
codeguru42 Mar 1, 2021
834911f
Generate dynamic openapi schema
codeguru42 Mar 1, 2021
924bdc3
Generate pretty API docs with Swagger UI
codeguru42 Mar 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions backend/api/templates/swagger-ui.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!DOCTYPE html>
<html>
<head>
<title>Swagger</title>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" type="text/css" href="//unpkg.com/swagger-ui-dist@3/swagger-ui.css" />
</head>
<body>
<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",
requestInterceptor: (request) => {
request.headers['X-CSRFToken'] = "{{ csrf_token }}"
return request;
}
})
</script>
</body>
</html>
15 changes: 14 additions & 1 deletion backend/api/urls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
from django.urls import path, include
from django.views.generic import TemplateView
from rest_framework import routers
from rest_framework.schemas import get_schema_view

from api import views

Expand All @@ -8,6 +10,17 @@
router = routers.DefaultRouter()
router.register(r'baseball_cards', views.BaseballCardViewSet)

schema_view = get_schema_view(
title="BBCT",
description="Baseball Card Tracker API",
version="1.0.0"
)

urlpatterns = [
path('', include(router.urls))
path('', include(router.urls)),
path('openapi-schema/', schema_view, name='openapi-schema'),
path('docs/', TemplateView.as_view(
template_name='swagger-ui.html',
extra_context={'schema_url': 'api:openapi-schema'}
), name='swagger-ui'),
]
45 changes: 44 additions & 1 deletion backend/poetry.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions backend/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ authors = ["Code-Apprentice <codeguru42@gmail.com>"]
python = "^3.7"
Django = "^3.1.7"
djangorestframework = "^3.12.2"
PyYAML = "^5.4.1"
uritemplate = "^3.0.1"

[tool.poetry.dev-dependencies]
model-bakery = "^1.2.1"
Expand Down