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.

Sign up for GitHub

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

Jump to bottom

Integrate Swagger for API Documentation #270

Open
3 tasks done
yusufaygun opened this issue Oct 11, 2024 · 0 comments
Open
3 tasks done

Integrate Swagger for API Documentation #270

yusufaygun opened this issue Oct 11, 2024 · 0 comments
Assignees
@sonerkuyar @yusufaygun
Labels
Component: Backend Issues related to server-side logic or infrastructure Priority: High This issue needs to be resolved ASAP Type: Documentation Tasks related to updating or creating documentation
Milestone
Milestone 1 - (In...

Comments

@yusufaygun
Copy link
Contributor

yusufaygun commented Oct 11, 2024 •
edited by sonerkuyar
Loading

Description

Research and integrate Swagger into the Django REST Framework project to document API endpoints before backend implementation. This will allow the frontend team to proceed with development based on the defined API endpoints.

Acceptance Criteria

  • Research has been done about integrating Swagger to the project before implementing endpoints.
  • Initial API endpoints are defined and documented.
  • API documentation is accessible via Swagger UI on a specified URL and in a file with .yaml format.

Reviewer:

This issue will be reviewed by: @isilsukarakuzuu
@yusufaygun yusufaygun added Type: Documentation Tasks related to updating or creating documentation Component: Backend Issues related to server-side logic or infrastructure labels Oct 11, 2024
@yusufaygun yusufaygun self-assigned this Oct 11, 2024
@yusufaygun yusufaygun added the Priority: High This issue needs to be resolved ASAP label Oct 11, 2024
@sonerkuyar sonerkuyar self-assigned this Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sonerkuyar sonerkuyar

@yusufaygun yusufaygun

Labels
Component: Backend Issues related to server-side logic or infrastructure Priority: High This issue needs to be resolved ASAP Type: Documentation Tasks related to updating or creating documentation
Projects
None yet
Milestone
Milestone 1 - (Infrastructure)
Development

No branches or pull requests
2 participants
@sonerkuyar @yusufaygun