Add optional OpenAPI YAML view by zeel2104 · Pull Request #766 · wemake-services/django-modern-rest

zeel2104 · 2026-03-28T21:13:23Z

I have made things!

AI Policy

I have read the AI Policy
and I agree to follow it
I have disclosed AI usage in this PR,
if any AI / LLM / coding agent was participating in the making of this PR
I have removed any "Co-Authored-By" lines that attribute coding agents
and I have carefully manually reviewed the final result produced by the AI

Checklist

I have double checked that there are no unrelated changes in this pull request (old patches, accidental config files, etc)
I have created at least one test case for the changes I have made
I have updated the documentation for the changes I have made

Related issues

Closes Support openapi.yaml #745

Summary

This PR adds support for serving the OpenAPI schema as openapi.yaml.

The new YAML view mirrors the existing openapi.json behavior and is only
available when msgspec is installed, using msgspec.yaml to serialize the
schema.

Changes

added OpenAPIYamlView
added a YAML dumping helper based on msgspec.yaml.encode
exported the YAML view only when msgspec is installed
added the openapi.yaml route in the test app conditionally
added unit and integration tests for the YAML endpoint
updated OpenAPI docs and examples to mention openapi.yaml

Testing

pytest --no-cov tests/test_unit/test_openapi/test_views.py tests/test_integration/test_openapi/test_views.py

sobolevn · 2026-03-28T21:25:17Z

 from server.apps.openapi.config import get_config

+try:
+    from dmr.openapi.views import OpenAPIYamlView


It should always be available in our test app

sobolevn · 2026-03-28T21:32:11Z

+
+def yaml_dumps(schema: object) -> str:
+    """Serialize schema to a decoded YAML string."""
+    return _yaml_dumps(schema)


do we need _yaml_dumps? can we just directly use msgspec?

sobolevn · 2026-03-28T21:32:47Z

+with suppress(ImportError):
+    from dmr.openapi.views.yaml import OpenAPIYamlView as OpenAPIYamlView


Suggested change

with suppress(ImportError):

from dmr.openapi.views.yaml import OpenAPIYamlView as OpenAPIYamlView

do not import it here, if it needs an expra dependency

sobolevn · 2026-03-28T21:33:27Z

 ]
-
-# openapi: {"openapi_url": "/docs/openapi.json/", "use_urlpatterns": true}  # noqa: ERA001
+# openapi: {"openapi_url": "/docs/openapi.yaml/", "use_urlpatterns": true}  # noqa: ERA001, E501


please, don't change this

kondratevdev

Please make sure that you have checked all the examples and documentation accurately.

kondratevdev · 2026-03-29T04:15:11Z

    path('docs/stoplight/', StoplightView.as_view(schema), name='stoplight'),
 ]

+urlpatterns.append(


Please, move it to previous urlpatterns section

urlpatterns = [ path(router.prefix, include((router.urls, 'server'), namespace='api')), path('docs/openapi.json/', OpenAPIJsonView.as_view(schema), name='openapi'), path('docs/redoc/', RedocView.as_view(schema), name='redoc'), path('docs/scalar/', ScalarView.as_view(schema), name='scalar'), path('docs/swagger/', SwaggerView.as_view(schema), name='swagger'), path('docs/stoplight/', StoplightView.as_view(schema), name='stoplight'), path('docs/openapi.yaml/', OpenAPIYamlView.as_view(schema), name='openapi_yaml') ]

kondratevdev · 2026-03-29T04:15:54Z

+    path(
+        'docs/openapi.yaml/',
+        OpenAPIYamlView.as_view(schema),
+        name='openapi-yaml',
+    ),
+)
+


Suggested change

path(

'docs/openapi.yaml/',

OpenAPIYamlView.as_view(schema),

name='openapi-yaml',

),

)

kondratevdev · 2026-03-29T04:17:34Z

@@ -0,0 +1,5 @@
+import msgspec


@sobolevn I think we should move it to plugins/msgspec folder, because we need try: ... except: condition for msgspec import

kondratevdev · 2026-03-29T04:19:27Z

@@ -0,0 +1,5 @@
+import msgspec
+
+def yaml_dumps(schema: object) -> str:


Suggested change

def yaml_dumps(schema: object) -> str:

def yaml_dumps(schema: 'ConvertedSchema') -> 'DumpedSchema':

kondratevdev · 2026-03-29T04:20:26Z

+    This view mirrors :class:`~dmr.openapi.views.json.OpenAPIJsonView`,
+    but renders the converted schema using ``msgspec.yaml``.


Suggested change

This view mirrors :class:`~dmr.openapi.views.json.OpenAPIJsonView`,

but renders the converted schema using ``msgspec.yaml``.

Produces a YAML representation of the :class:`~dmr.openapi.objects.OpenAPI`

specification that can be used by API documentation tools

and client code generators.

kondratevdev · 2026-03-29T04:28:08Z

 from dmr.test import DMRClient

+try:
+    from dmr.openapi.views.yaml import OpenAPIYamlView


You must check yaml_dumps import, not view

kondratevdev · 2026-03-29T04:29:24Z

Suggested change

def test_json_returns_correct_structure(dmr_client: DMRClient) -> None:

kondratevdev · 2026-03-29T04:29:34Z

+    OpenAPIYamlView is None,
+    reason='`msgspec` is required for OpenAPI YAML endpoint',
+)
+def test_yaml_endpoint_returns_correct_structure(dmr_client: DMRClient) -> None:


Suggested change

def test_yaml_endpoint_returns_correct_structure(dmr_client: DMRClient) -> None:

def test_yaml_returns_correct_structure(dmr_client: DMRClient) -> None:

kondratevdev · 2026-03-29T04:30:55Z

+    assert OpenAPIYamlView is not None
+


Suggested change

assert OpenAPIYamlView is not None

kondratevdev · 2026-03-29T04:32:32Z

 from server.apps.models_example import urls as models_example_urls
 from server.apps.negotiations import urls as negotiations_urls
 from server.apps.openapi.config import get_config
+from dmr.openapi.views.yaml import OpenAPIYamlView


Suggested change

from dmr.openapi.views.yaml import OpenAPIYamlView

from dmr.openapi.views import OpenAPIYamlView

You need to make re-export (check __init__.py

for more information, see https://pre-commit.ci

kondratevdev · 2026-03-30T06:00:39Z

    StoplightView,
    SwaggerView,
 )
+from dmr.openapi.views.yaml import OpenAPIYamlView


Suggested change

from dmr.openapi.views.yaml import OpenAPIYamlView

from dmr.openapi.views import OpenAPIYamlView

for more information, see https://pre-commit.ci

codspeed-hq · 2026-04-05T17:01:26Z

Merging this PR will not alter performance

✅ 5 untouched benchmarks

_{Comparing zeel2104:feature/openapi-yaml-view (fb4a900) with master (94dd7fa)}

for more information, see https://pre-commit.ci

codecov · 2026-04-05T17:15:16Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (94dd7fa) to head (fb4a900).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##            master      #766   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          333       334    +1     
  Lines        13085     13111   +26     
  Branches       413       413           
=========================================
+ Hits         13085     13111   +26

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

sobolevn · 2026-04-05T17:17:08Z

@zeel2104 thanks a lot! Great work!

I fixed some minor things and merged it.
This change is comming in 0.5.0 :)

Add optional OpenAPI YAML view

c816b20

sobolevn reviewed Mar 28, 2026

View reviewed changes

Address review feedback

83c7ee6

kondratevdev reviewed Mar 29, 2026

View reviewed changes

zeel2104 and others added 4 commits March 29, 2026 21:42

Adjust yaml view per review

d5552c1

Trigger mergeability check

31b1cca

Merge branch 'master' into feature/openapi-yaml-view

e959e6d

[pre-commit.ci] auto fixes from pre-commit.com hooks

55bb2dc

for more information, see https://pre-commit.ci

kondratevdev reviewed Mar 30, 2026

View reviewed changes

zeel2104 and others added 4 commits March 30, 2026 12:34

Fix lint issues in yaml view

9cb76c8

[pre-commit.ci] auto fixes from pre-commit.com hooks

e41cf35

for more information, see https://pre-commit.ci

Merge branch 'master' into feature/openapi-yaml-view

5669fc7

Merge

7568976

sobolevn and others added 2 commits April 5, 2026 20:06

Fix CI

48a2ca9

[pre-commit.ci] auto fixes from pre-commit.com hooks

fb4a900

for more information, see https://pre-commit.ci

sobolevn merged commit 12b8701 into wemake-services:master Apr 5, 2026
27 checks passed

		with suppress(ImportError):
		from dmr.openapi.views.yaml import OpenAPIYamlView as OpenAPIYamlView

		@@ -0,0 +1,5 @@
		import msgspec

		def yaml_dumps(schema: object) -> str:

	def yaml_dumps(schema: object) -> str:
	def yaml_dumps(schema: 'ConvertedSchema') -> 'DumpedSchema':

		This view mirrors :class:`~dmr.openapi.views.json.OpenAPIJsonView`,
		but renders the converted schema using ``msgspec.yaml``.

-    This view mirrors :class:`~dmr.openapi.views.json.OpenAPIJsonView`,
-    but renders the converted schema using ``msgspec.yaml``.
+    Produces a YAML representation of the :class:`~dmr.openapi.objects.OpenAPI`
+    specification that can be used by API documentation tools
+    and client code generators.


	def test_json_returns_correct_structure(dmr_client: DMRClient) -> None:

	def test_yaml_endpoint_returns_correct_structure(dmr_client: DMRClient) -> None:
	def test_yaml_returns_correct_structure(dmr_client: DMRClient) -> None:

	from dmr.openapi.views.yaml import OpenAPIYamlView
	from dmr.openapi.views import OpenAPIYamlView

Uh oh!

Conversation

zeel2104 commented Mar 28, 2026

I have made things!

AI Policy

Checklist

Related issues

Summary

Changes

Testing

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kondratevdev left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codspeed-hq Bot commented Apr 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will not alter performance

Uh oh!

codecov Bot commented Apr 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

sobolevn commented Apr 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codspeed-hq Bot commented Apr 5, 2026 •

edited

Loading

codecov Bot commented Apr 5, 2026 •

edited

Loading