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

Add API interfaces to documentation #23

Open
vsoch opened this issue Oct 28, 2020 · 2 comments
Open

Add API interfaces to documentation #23

vsoch opened this issue Oct 28, 2020 · 2 comments

Comments

@vsoch
Copy link
Owner

vsoch commented Oct 28, 2020

Rest framework has several nice interfaces that we should add to documentation - I'm thinking an interfaces page that will share content with #11.

@ad-m
Copy link

ad-m commented Nov 4, 2020

DRF-YASG is pretty useful to provide Swagger 2.0: https://github.com/axnsan12/drf-yasg
Swagger 2.0 allows to use API documentation UI like Swagger or ReDoc. Docker Engine API use ReDoc for documentation: https://docs.docker.com/engine/api/v1.40/#operation/ContainerCreate

@vsoch
Copy link
Owner Author

vsoch commented Nov 4, 2020

Thanks @ad-m - there currently already is a nice interface (and I mostly need to take screenshots of it) and I've used those modules on other projects. I'm going to label as an enhancement and wait for more general/community feedback asking for swagger to decide if it's worth implementing

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

No branches or pull requests

2 participants