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

Issue 75 documenting APIs #79

Merged
merged 5 commits into from
Jan 24, 2025
Merged

Issue 75 documenting APIs #79

merged 5 commits into from
Jan 24, 2025

Conversation

TroubledPhilip
Copy link
Contributor

@TroubledPhilip TroubledPhilip commented Jan 22, 2025

integrate the OpenAPI to generate API documentation

now developers can visit http://localhost:8000/api/schema/swagger-ui/ to read through information about all APIs

For more information, here's the documentation of drf-spectacular
https://drf-spectacular.readthedocs.io/en/latest/index.html

Other Information

bdec5c7995d5c7fb4ab175c33479dc9

Related issue

@TroubledPhilip TroubledPhilip linked an issue Jan 22, 2025 that may be closed by this pull request
@yunho7687
Copy link
Member

in my latest commit, I fixed partial password hashing bug mentioned in #78
lgtm and can be approved

Copy link
Member

@yunho7687 yunho7687 left a comment

Choose a reason for hiding this comment

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

well done! finally we got our api doc!

@torry2 torry2 self-requested a review January 24, 2025 12:02
Copy link
Contributor

@torry2 torry2 left a comment

Choose a reason for hiding this comment

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

LGTM

@torry2 torry2 merged commit 564afc3 into main Jan 24, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documenting APIs
3 participants