Added Swagger documentation API #19
Conversation
webapp/coderplex_apis/urls.py
Outdated
| url(r'^admin/', admin.site.urls), | ||
| url(r'^', include('books.urls')), | ||
| url(r'^$', views.HelloWordView.as_view()), | ||
| url(r'^$', schema_view), |
There was a problem hiding this comment.
add the docs route to something like "api-docs", the way you implemented, makes the api documentation as default route of api.coderplex
|
What about API.md now ? Should I remove it ? |
| url(r'^', include('books.urls')), | ||
| url(r'^$', schema_view), | ||
| url(r'^$', views.HelloWordView.as_view()), | ||
| url(r'^api-docs$', schema_view), |
There was a problem hiding this comment.
looks good, are you able to access the api docs at http://localhost:8000/api-docs ? if yes, we are good with this.
There was a problem hiding this comment.
Yes, I am able to access them at http://localhost:8000/api-docs
There was a problem hiding this comment.
perfect then, if you make the changes for Changed Contributing Guidelines to add about Swagger , its good to go for a merge.
There was a problem hiding this comment.
what about API.md ? Should I keep it or remove it?
There was a problem hiding this comment.
I don't see any necessity for 2 Api documentations, its confusing to know which one is up to date. swagger anyways, is live documentation is obviously up to date with out any changes, so you can remove API.md
2 participants
Swagger Documentation API/api-docsrouteAPI.mdfile