Re: Documenting responses

2018-08-26 Thread Jason
Hmm, ok. The extra info helps. FWIW, at work, we're moving off Swagger for reasons not clear to me, and my team mainly uses Apiary with some mkdocs stuff. So you could look into those? On Sunday, August 26, 2018 at 11:00:09 AM UTC-4, ju5t wrote: > > Sorry, perhaps I should have posted what I

Re: Documenting responses

2018-08-26 Thread 'ju5t' via Django REST framework
Sorry, perhaps I should have posted what I have done already. We've been running Swagger for a while already and are currently looking into the default documentation options in DRF as they have been improving. The documentation didn't answer my question unfortunately. I'm specifically looking t

Re: Documenting responses

2018-08-26 Thread Jason
have you looked at http://www.django-rest-framework.org/topics/documenting-your-api/ you can add all that example info to the docstring of a view. Alternatively, there's https://github.com/marcgibbons/django-rest-swagger/ and apiary, which are two options you can use to document your API. --

Documenting responses

2018-08-26 Thread 'ju5t' via Django REST framework
I'm trying to improve the documentation of our API. It took me a little while to find out that `help_text` adds the description but apart from that things are getting along as expected. The only problem I have at the moment is that I would like to document the responses, including the errors yo