search

vsoch / django-oci

Open Containers distribution spec module for Django (under development)
https://vsoch.github.io/django-oci/
Other
16 stars 1 forks source link

Add API interfaces to documentation #23

Open vsoch opened 4 years ago

vsoch commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

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