grpc-ecosystem/grpc-gateway

Please add option to use FQN as swagger name

Open

#471 建立於 2017年10月7日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)Go (16,971 star) (2,250 fork)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
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.