Skip to content
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.

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

Use drf-yasg for demo project #215

Merged
merged 1 commit into from
Jan 28, 2021
Merged

Conversation

hashlash
Copy link

Previously on the demo project, /docs raise an error caused by django-rest-swagger (related issue). And since the project is no longer maintained, we can use drf-yasg as its alternative (as mentioned on the repo).

Copy link

@auvipy auvipy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hashlash
Copy link
Author

@auvipy, I haven't actually explored any other alternatives yet. I just saw that drf-yasg is mentioned on the deprecated django-rest-swagger's repo, and it just works :)

@iMerica iMerica merged commit 732935d into iMerica:master Jan 28, 2021
@tfranzel
Copy link

A little late to the party but i just stumbled over this and wanted to let you guys know there is another alternative: drf-spectacular https://github.com/tfranzel/drf-spectacular/ (disclaimer: author speaking 😄 )

Since some views here are not introspectable (e.g. no serializer_class attr), we added explicit declarations for the missing pieces. Due to this explicit support i'm quite confident the schema would look a lot better than drf-yasg or DRF native.

This is the test schema for our dj_rest_auth contrib support. You can judge it yourself: https://github.com/tfranzel/drf-spectacular/blob/master/tests/contrib/test_rest_auth.yml

have a nice day!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants