Skip to content
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 Swagger documentation to API #300

Closed
wants to merge 2 commits into from
Closed

Conversation

jraddaoui
Copy link
Contributor

@jraddaoui jraddaoui commented Dec 31, 2017

Use django-tastypie-swagger to create Swagger documentation and UI,
available at '.../api/v1/doc/' and '.../api/v2/doc/'.

TODO:

  • - Fix file/package resource
  • - Add auth. to doc pages?
  • - Add custom endpoints/methods

connects to #299

@jraddaoui jraddaoui changed the title Add Swagger documentation to API, refs #299 Add Swagger documentation to API Dec 31, 2017
@qubot qubot force-pushed the dev/tastypie-swagger branch from fd05d7b to e4883ce Compare December 31, 2017 07:16
@jraddaoui jraddaoui self-assigned this Dec 31, 2017
@jraddaoui jraddaoui requested a review from jhsimpson December 31, 2017 07:18
@jrwdunham jrwdunham mentioned this pull request May 16, 2018
@jrwdunham jrwdunham mentioned this pull request Jun 5, 2018
kwargs={
'tastypie_api_module': v2_api,
'namespace': 'v2_api_swagger',
'version': '1.0'}),
Copy link
Contributor

Choose a reason for hiding this comment

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

@jraddaoui are the versions mixed up here? It looks like the v2/ endpoints are associated to version 1.0 and the v1/ endpoints are associated to version 2.0.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @jrwdunham,

Yes, correct namespace and module but swapped version string, sorry ;)

@jrwdunham
Copy link
Contributor

This PR makes the Swagger UI visible at /api/v1/doc/ and /api/v2/doc/. It looks like this:

am-ss-swagger-ui-screenshot

@sallain sallain added Status: in progress Issue that is currently being worked on. Waffle label. and removed work-in-progress labels Jul 17, 2018
@sevein sevein added the stalled label Mar 8, 2021
@sevein sevein removed the Status: in progress Issue that is currently being worked on. Waffle label. label Mar 25, 2021
@sevein sevein closed this Mar 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants