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

feat: add gen api @doc comment to logic handler routes #3790

Merged
merged 3 commits into from
Mar 30, 2024

Conversation

ch3nnn
Copy link
Contributor

@ch3nnn ch3nnn commented Dec 13, 2023

example:

demo.api

syntax = "v1"

type Request {
	Name string `path:"name,options=you|me"`
}

type Response {
	Message string `json:"message"`
}

service demo-api {

	@doc "demo comment"
	@handler DemoHandler
	get /from/:name(Request) returns (Response)

	@doc ("demo list comment")
	@handler DemoListHandler
	get /from/list returns (Response)

	@doc(
		summary: "comment comment comment"
	)
	@handler NoResponseHandler
	get /from/get (Request)
}

generate logic handler routes comment

image

image

image

@ch3nnn
Copy link
Contributor Author

ch3nnn commented Dec 13, 2023

@kevwan I hope you can help me see if this change is reasonable and correct. thank!

@kevwan kevwan added the area/api Categorizes issue or PR as related to API syntax or usages. label Dec 16, 2023
Copy link
Collaborator

@kesonan kesonan left a comment

Choose a reason for hiding this comment

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

LGTM

@ch3nnn
Copy link
Contributor Author

ch3nnn commented Mar 18, 2024

i see change approved, want to know the current PR can be merged ? @kevwan

Copy link

codecov bot commented Mar 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.14%. Comparing base (2629636) to head (7e31aa9).
Report is 40 commits behind head on master.

Additional details and impacted files

see 253 files with indirect coverage changes

@kevwan kevwan added this pull request to the merge queue Mar 30, 2024
Merged via the queue into zeromicro:master with commit 8c0bb27 Mar 30, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api Categorizes issue or PR as related to API syntax or usages.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants