grpc-ecosystem/grpc-gateway

Please add option to use FQN as swagger name

Open

#471 opened on Oct 7, 2017

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

Description

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 ?

Contributor guide

Tech stack
go
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programmingProtocol BuffersgRPCSwagger/OpenAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.