Closed nascentcore-eng closed 1 year ago
We can use https://github.com/swaggo/swag package to help starship generate openapi swagger-style doc.
Agree to use swag
, Starship urgently needs to solve the API documentation, not other technical defective, although grpc-gateway
is also embedded in the program, but we need to transform our current http api
into grpc way, which is not suitable for the current stage to do those changes.
With swag
, we can just need to import swag
package, and add some annotation code https://github.com/swaggo/swag#how-to-use-it-with-gin
Is your feature request related to a problem? Please describe. We don't have a scheme-description as code, like protobuf for HTTP service. That could become a problem for working with frontend developers.
Describe the solution you'd like Create a swagger definition @jmzwcn @JaredTan95 @owl-ltt might have more ideas.
Describe alternatives you've considered grpc web grpc-http gateway
Additional context None