Skip to content
This repository was archived by the owner on Aug 19, 2019. It is now read-only.

Added Swagger documentation API #19

Merged
merged 4 commits into from
Nov 29, 2017
Merged

Added Swagger documentation API #19

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b938a5b
very small typo
pbteja1998 Nov 29, 2017
ae953f9
added swagger documentation api
pbteja1998 Nov 29, 2017
2daacc6
changed the url of swagger docs to '/api-docs'
pbteja1998 Nov 29, 2017
f2e6377
added about swagger route in Contributing Guidelines and deleted API.md
pbteja1998 Nov 29, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ We welcome pull requests from beginners and django developers alike!

### Work on Issues

1. Find an issue that needs assistance by searching for the [open issues](https://github.com/coderplex/coderplex-backend/labels/help wanted).
1. Find an issue that needs assistance by searching for the [open issues](https://github.com/coderplex/coderplex-backend/labels/help-wanted).
1. If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don’t accidentally duplicate your effort.
1. If somebody claims an issue but doesn’t follow up for more than a weeks, it’s fine to take over it but you should still leave a comment.

Expand Down
Binary file modified webapp/coderplex_apis/db.sqlite3
View file
Open in desktop
Binary file not shown.
1 change: 1 addition & 0 deletions webapp/coderplex_apis/settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
'rest_framework',
'rest_framework.authtoken',
'rest_auth',
'rest_framework_swagger',

'allauth',
'allauth.account',
Expand Down
3 changes: 3 additions & 0 deletions webapp/coderplex_apis/urls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,14 @@
from rest_framework_jwt.views import obtain_jwt_token
from rest_framework_jwt.views import refresh_jwt_token
from rest_framework_jwt.views import verify_jwt_token
from rest_framework_swagger.views import get_swagger_view
schema_view = get_swagger_view(title='CoderPlex APIs')

urlpatterns = [
url(r'^admin/', admin.site.urls),
url(r'^', include('books.urls')),
url(r'^$', views.HelloWordView.as_view()),
url(r'^api-docs$', schema_view),
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good, are you able to access the api docs at http://localhost:8000/api-docs ? if yes, we are good with this.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I am able to access them at http://localhost:8000/api-docs

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perfect then, if you make the changes for Changed Contributing Guidelines to add about Swagger , its good to go for a merge.

Copy link
Author

@pbteja1998 pbteja1998 Nov 29, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what about API.md ? Should I keep it or remove it?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

url(r'^v1/', include('authentication.urls')),
url(r'^callback', views.SocialCodeView.as_view()),
url(r'^api-token-auth', obtain_jwt_token),
Expand Down