Add support for documenting API

[Ugtan]

Fixes #91

[Ugtan]

@rtgdk I just found out why travis is failing. Drf-yasg works with django rest framework version 3.7.7 or greater which i didn't notice as when i install drf-yasg in my local machine it automatically upgraded the drf to 3.7.7. Moreover, this is also not working well with the current source, so, i think it is better to just drop this idea and use Postman instead. What do you think?

[rtgdk]

@Ugtan Cool, go for postman.

[Ugtan]

@rtgdk I was talking about this tool in which there is no need to enter curl commands just running the server and using the various api endpoints work well, i have tested it too. So, Should i just remove my above commit and add about this tool in the readme section? or just close the issue and modify this PR?

[rtgdk]

@Ugtan Yeah I know about postman. I would like if the documentation can be created by postman with as little changes as possible to the api structure and source code.

[Ugtan]

@rtgdk There is no need to change anything, i have tried using one of the api endpoints and it is working fine. I will try using the other api endpoints as well and will update this PR soon!

[Ugtan]

@rtgdk Please have a look on the documentation here. I would like to have your thoughts on this. Thanks.

[rtgdk]

@Ugtan Looks great. I like the different languages api helper functions. Although, installing postman to run these seems not a good idea since its a third party tool.(If there's a way to run/test these endpoints from the online-tool itself, that would be great, I think swagger docs provide that ability, can you check?). Is there a way to port these documentation of different languages provided by postman into the online-tools on a separate url /documentation or port these to github wiki pages since using the above url is not efficient.

[Ugtan]

If there's a way to run/test these endpoints from the online-tool itself, that would be great, I think swagger docs provide that ability, can you check?

I have already tried using the swagger docs, the problem i am facing with swagger and coreapi is that they are not providing options to upload file with the current source code. I tried looking around but not able to find a solution.

Is there a way to port these documentation of different languages provided by postman into the online-tools on a separate url /documentation or port these to github wiki pages since using the above url is not efficient.

Postman pro allows to serve the documentation on a custom domain but the main disadvantage is its paid. I agree with you that using the above url is not efficient. I will try to figure something out. @rtgdk

[rtgdk]

@Ugtan @goneall As mentioned on #323, not sure if the generated swagger specs are correct or are we missing anything, closing this one.