-
Notifications
You must be signed in to change notification settings - Fork 57
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 support for documenting API #91
Comments
If it sounds good to you, i would like to add PR for the same. Thanks |
Looks a good idea to me. Keep the module library as little as possible. Do not include unnecessary python modules for creating documentation and snippets. Use the DRF built-in docs api wherever possible. |
I have actually tried using a third party module and not the build in docs api. I think it is better than the coreapi(as it supports swaggerui and redocs view as well). Please have a look and let me know if i should proceed with it or not. Also, if it doesn't work out we can switch to the default one. |
@Ugtan You can try using this one. Still I would prefer using the default one provided by DRF, since a new third party module will add new maintenance checks. Go for the third party one and lets see if it is worth it. |
@rtgdk I tried using the default one by it does have the option for file upload and we might have to change some source code which is not good. Although, i will make a PR of the mention one. PS- Sorry about closing the issue, there was a pop up in my phone and i was closing it and by mistake closed the issue |
@BassCoder2808 There has been some work done on this but wasn't merged. Ideal solution would be to generate swagger specs directly from the api defined and host it directly on github.io |
Hi @BanulaKumarage, as far as I had understood the issue because I was currently working on it :), we need to create the API documentation for all the current end-points in Swagger-ui. I had gone through your PR and @rtgdk can correct me if I am wrong, we need not change the |
Hi @BassCoder2808 when we add the url in url.py in API, we can access this endpoint of swagger endpoint through our application using api/swagger endpoint. |
Yes totally agreed we can put that in |
@BassCoder2808 Need a clarification. The requirement is to have an API documentation. So why is it focusing specially on deploying it in |
@BanulaKumarage @BassCoder2808 Ideally we only want to host Also, we want to host this documentation online. Currently it exists here - https://github.com/spdx/spdx-online-tools/wiki/REST-API-Fields-Request-and-Response and every fields in every api should be documented on the generated swagger page. We might have to update documentation inside django using https://github.com/spdx/spdx-online-tools/wiki/REST-API-Fields-Request-and-Response or even write/update new one. |
Although, the wiki here is enough to interact with the API but adding a support for API documentation will help people new to the repo, understand what the API can do without access to source code. It will also help them to see all the API endpoints available so that they can use these endpoints to test and analyze the requests and responses of the API endpoints which is not really possible in entering curl commands.
The text was updated successfully, but these errors were encountered: