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

Support swagger #24

Merged
merged 4 commits into from
Sep 19, 2023
Merged

Support swagger #24

merged 4 commits into from
Sep 19, 2023

Conversation

slhmy
Copy link
Member

@slhmy slhmy commented Sep 17, 2023 •
edited
Loading

Should be noticed that we should use comments in a godoc style:

// UpdateAccount updates data for a specific account
//
//	@Summary		Update account

So that we can keep the swagger fmt tidy.

After this PR, while server.swagger_on is true, a /swagger/* route will be served, and API docs can be viewed in /swagger/index.html.

@slhmy slhmy requested a review from akamya997 September 19, 2023 03:59
akamya997
akamya997 approved these changes Sep 19, 2023
View reviewed changes
Copy link
Contributor

@akamya997 akamya997 left a comment

Choose a reason for hiding this comment

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

LGTM, we can config the host later.

@akamya997 akamya997 merged commit 4098f8c into main Sep 19, 2023
1 check passed
@slhmy slhmy deleted the slhmy/swagger branch October 11, 2023 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@akamya997 akamya997 akamya997 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@slhmy @akamya997