search

MTPRM / mtprm-proto

Proto
0 stars 0 forks source link

Generate GRPC gateway openapi docs view #7

Closed achaphiv closed 2 months ago

achaphiv commented 2 months ago

Goal: provide developer documentation for REST (grpc-gateway) api

Blocked by #6.

TODO

The buf plugin currently generates multiple openapi .json files.

Somehow show:

The multiple swagger files as one combined view.

OR

Use a <select> to pick an endpoint and view separately.

Potential solutions

Combine files: https://stackoverflow.com/questions/54586137/how-do-i-combine-multiple-openapi-3-specification-files-together

View separately: https://github.com/Redocly/redoc/issues/226

achaphiv commented 2 months ago

Switched from redoc to scalar: 82656d210eaeafb9271ea339903a283bd3b2ba9d

achaphiv commented 2 months ago

Seems okay for now. We'll have new issues to deal with filtering unused models, etc.