cloudwego / cloudwego/hertz

[Feature Request]auto gen swagger comment for handler

Open
#766 5 comments 0 reactions 1 assignee Claimed by @FGYFFFF View on GitHub
enhancement
Dominant language
Go
Stars
7.4k
Forks
643
Avg merge
14h 5m
Merged PRs (30d)
2

Description

**Is your feature request related to a problem? Please describe.**

when using idl for generate code, we currently add some simple comments for each handler
https://github.com/cloudwego/hertz/blob/0d8b98bc8cf61c16866359e551959e962597d33f/cmd/hz/generator/handler.go#L247-L261

but we have fully information for this endpoint, e.g. http method, serializer type, url path, request params, response params, and we have full info for request struct and response struct, like which field is used in path/query/body. So we can add a flag for hz to control generating swagger style comment for each method.

previous relates issues #28, #538, #558, #692

**Describe the solution you'd like**

In HttpMethod.InitComment, generate swagger style comment for using https://github.com/hertz-contrib/swagger

**Describe alternatives you've considered**

maybe we could provider a template like layout and package for the swagger comments.

**Additional context**

Add any other context or screenshots about the feature request here.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.