grpc-ecosystem/grpc-gateway

Please add option to use FQN as swagger name

Open

#471 opened on 2017年10月7日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)Go (16,971 stars) (2,250 forks)batch import
enhancementhelp wantedopenapi

説明

The default logic to map FQN to swagger name is good(https://github.com/grpc-ecosystem/grpc-gateway/blob/master/protoc-gen-swagger/genswagger/template.go#L332).

We have many proto files. and they have some import with each other. Use the logic to shortten FQN is not so good in some case.

e.g.

retail.proto has message CreateOrderRequest {} warehouse.proto also has message CreateOrderRequest {}

If warehouse.proto was imported by retail, warehouse.CreateOrderRequest will use warehouseCreateOrderRequest as swagger name in retail.swagger.json. But the swagger file generated by warehouse.proto was CreateOrderRequest. It's hard for us to merge the two swagger file into one.

I prefer keep the FQN as swagger name, any ideas ?

コントリビューターガイド

技術スタック
go
領域
backendapi
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Go programmingProtocol BuffersgRPCSwagger/OpenAPI
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
40
調査方針
The issue requests a new option to use fully qualified names in Swagger definitions. Currently, the naming logic is in `protoc gen swagger/genswagger/template.go` around line 332. To implement, a new flag could be added to the protoc plugin to toggle between short names and FQN. Consider reviewing existing configuration patterns in the repository and any previous discussions in the issue comments.