Skip to content

Avoid naming conflicts #408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
guiguan wants to merge 1 commit into from
Closed

Avoid naming conflicts #408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions pkg/codegen/codegen.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,7 @@ func GenerateTypesForParameters(t *template.Template, params map[string]*openapi
var types []TypeDefinition
for _, paramName := range SortedParameterKeys(params) {
paramOrRef := params[paramName]
paramName += componentNameSuffixParameters

goType, err := paramToGoType(paramOrRef.Value, nil)
if err != nil {
Expand Down Expand Up @@ -427,6 +428,7 @@ func GenerateTypesForResponses(t *template.Template, responses openapi3.Response

for _, responseName := range SortedResponsesKeys(responses) {
responseOrRef := responses[responseName]
responseName += componentNameSuffixResponses

// We have to generate the response object. We're only going to
// handle application/json media types here. Other responses should
Expand Down Expand Up @@ -466,6 +468,7 @@ func GenerateTypesForRequestBodies(t *template.Template, bodies map[string]*open

for _, bodyName := range SortedRequestBodyKeys(bodies) {
bodyOrRef := bodies[bodyName]
bodyName += componentNameSuffixRequestBodies

// As for responses, we will only generate Go code for JSON bodies,
// the other body formats are up to the user.
Expand Down
17 changes: 17 additions & 0 deletions pkg/codegen/utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,10 +205,19 @@ func StringInArray(str string, array []string) bool {
return false
}

// these suffixes are used for avoiding naming conflicts in code generation, because all four
// component types will be generated in the same package
const (
componentNameSuffixParameters = "Param"
componentNameSuffixResponses = "Response"
componentNameSuffixRequestBodies = "Request"
)

// This function takes a $ref value and converts it to a Go typename.
// #/components/schemas/Foo -> Foo
// #/components/parameters/Bar -> Bar
// #/components/responses/Baz -> Baz
// #/components/requestBodies/Baz -> Baz
// Remote components (document.json#/Foo) are supported if they present in --import-mapping
// URL components (http://deepmap.com/schemas/document.json#Foo) are supported if they present in --import-mapping
//
Expand All @@ -218,6 +227,14 @@ func RefPathToGoType(refPath string) (string, error) {
if depth := len(pathParts); depth != 4 {
return "", fmt.Errorf("Parameter nesting is deeper than supported: %s has %d", refPath, depth)
}
switch pathParts[2] {
case "parameters":
pathParts[3] += componentNameSuffixParameters
case "responses":
pathParts[3] += componentNameSuffixResponses
case "requestBodies":
pathParts[3] += componentNameSuffixRequestBodies
}
return SchemaNameToTypeName(pathParts[3]), nil
}
pathParts := strings.Split(refPath, "#")
Expand Down