API Documentation - Django REST Framework Docs

[Marc Gibbons]

Hello,

I have developed a tool for which generates an inventory and documentation for your Django REST Framework URL endpoints based on your code and your docstring comments. Link to the repo is below. Contributions are most welcome! 

https://github.com/marcgibbons/django-rest-framework-docs

Many thanks,

Marc

[Scott White]

Just installed it, really neat. For the lists, maybe add a link to the resource?

Thanks for sharing this,

Scott

[Tom Christie]

I took a look at this a while back, and it really is pretty neat - thanks Marc!

One thing I didn't notice until you posted this tho' was that it provides endpoints that describe the API.

I've probably hinted towards this before, but it looks like you've got something really close to being able to plug into an API documentation auto-generator like swagger...

https://developers.helloreverb.com/swagger/

Swagger requires you to provide certain endpoints describing the API...

* https://github.com/wordnik/swagger-core/wiki/Resource-Listing

* https://github.com/wordnik/swagger-core/wiki/API-Declaration

* https://github.com/wordnik/swagger-core/wiki/Parameters 

and then generates a snazzy front end description & api explorer for it...

http://petstore.swagger.wordnik.com/

If you've got the time & the inclination it might be worth having a look into.

Just a thought :-p

Also if anyone wants to get together a pull request for a docs page listing all the third party packages for REST framework that'd def be a worthwhile addition to the docs.

(Aside: Apologies marc for being slow at getting around to dealing with your docs PR, will try to find some time to discuss)

Cheers,

  Tom

[Marc Gibbons]

Hi Tom,

Yes - Swagger UI is beautiful - and was my inspiration for doing this in the first place! I'm working on producing discoverable endpoints in the format Swagger expects. I am wondering how it handles nested structures (ie. /countries/{id}/cities/{id}/some-endpoint).

Thanks for the feedback!

Marc

[Manolo García]

Hi, I'm currently using django-rest-swagger. Great job by the way ;)

I have a little problem:

* Path Parameters will be shown as soon as you have them in your URL pattern.

* Query Parameters will be shown if you add them in your doc-strings '''param -- param description'''

* But how do show show in Swagger-UI the Post Parameters?

[Ravi Bhushan]

Please help me for this problem 

https://stackoverflow.com/questions/50367739/rest-framework-3-7-with-django-2-0-post-method-does-not-working-in-api-document?noredirect=1#comment87755771_50367739