Skip to content

fix: add x-go-name for server urls #2304

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

Open
dhpollack wants to merge 1 commit into
base: main
Choose a base branch
from
+33 −5
Open

fix: add x-go-name for server urls #2304

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
4 changes: 4 additions & 0 deletions examples/generate/serverurls/api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,7 @@ servers:
description: some lowercase name
# there may be URLs on their own, without a `description`
- url: http://localhost:443
# x-go-name overrides the auto-generated Go name
- url: https://api.example.com/v2
description: Custom named server
x-go-name: MyCustomAPIServer
10 changes: 10 additions & 0 deletions examples/generate/serverurls/gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions examples/generate/serverurls/gen_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,9 @@ func TestServerUrlTheProductionAPIServer(t *testing.T) {
assert.Equal(t, "https://demo.gigantic-server.com:8443/v2", serverUrl)
})
}

func TestXGoName(t *testing.T) {
t.Run("x-go-name overrides the auto-generated server name", func(t *testing.T) {
assert.Equal(t, "https://api.example.com/v2", MyCustomAPIServer)
})
}
18 changes: 13 additions & 5 deletions pkg/codegen/server_urls.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,20 @@ func GenerateServerURLs(t *template.Template, spec *openapi3.T) (string, error)
names := make(map[string]*openapi3.Server)

for _, server := range spec.Servers {
suffix := server.Description
if suffix == "" {
suffix = nameNormalizer(server.URL)
var name string
if goNameExt, ok := server.Extensions[extGoName]; ok {
if customName, err := extParseGoFieldName(goNameExt); err == nil && customName != "" {
name = customName
}
}
if name == "" {
suffix := server.Description
if suffix == "" {
suffix = nameNormalizer(server.URL)
}
name = serverURLPrefix + UppercaseFirstCharacter(suffix)
name = nameNormalizer(name)
}
name := serverURLPrefix + UppercaseFirstCharacter(suffix)
name = nameNormalizer(name)

// if this is the only type with this name, store it
if _, conflict := names[name]; !conflict {
Expand Down