cwgo icon indicating copy to clipboard operation
cwgo copied to clipboard

proposal: generate API docs for API server

Open welkeyever opened this issue 3 years ago • 2 comments

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

No

Describe the solution you'd like

Generate api docs for api server(hertz/kitex), maybe integrating protoc/thrift plugin during the generation phase.

Describe alternatives you've considered

Hertz may cooperate with swagger middleware. Kitex not sure for now...

Additional context

welkeyever avatar Feb 10 '23 08:02 welkeyever

The thrift/protoc plug-in implementation is the most ideal. The protobuf plugin is currently available, thrift is not.

Middleware is also possible, but requires kitex support for a swagger middleware

FGYFFFF avatar Feb 10 '23 09:02 FGYFFFF

There are real user requirements that exist for thrift to generate swagger. cc @chaoranz758

li-jin-gou avatar Jan 02 '24 07:01 li-jin-gou