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

proposal: generate API docs for API server #35

Open
welkeyever opened this issue Feb 10, 2023 · 2 comments
Open

proposal: generate API docs for API server #35

welkeyever opened this issue Feb 10, 2023 · 2 comments
Labels
E-help-wanted Stuff where we want help. enhancement tool

Comments

@welkeyever
Copy link
Member

welkeyever commented Feb 10, 2023 •
edited

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 welkeyever changed the title proposal: generate API proposal: generate API docs for API server Feb 10, 2023
@FGYFFFF
Copy link
Contributor

FGYFFFF commented Feb 10, 2023

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

@li-jin-gou li-jin-gou added the E-help-wanted Stuff where we want help. label Dec 3, 2023
@li-jin-gou
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
E-help-wanted Stuff where we want help. enhancement tool
Milestone
No milestone
Development

No branches or pull requests
4 participants
@welkeyever @FGYFFFF @li-jin-gou @chaoranz758