Skip to content

[Golang] Support multiple APIKeys#3210

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
nmuesch wants to merge 4 commits into from
Closed

[Golang] Support multiple APIKeys #3210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dae864a
Support multiple API Keys
nmuesch Jun 21, 2019
391e7d8
Multiple context approach
nmuesch Jun 21, 2019
31620d3
Update sample
nmuesch Jun 24, 2019
564f4b0
Fix test failures
nmuesch Jun 24, 2019
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
2 changes: 1 addition & 1 deletion modules/openapi-generator/src/main/resources/go/api.mustache
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -238,7 +238,7 @@ func (a *{{{classname}}}Service) {{{nickname}}}(ctx context.Context{{#hasParams}
{{^isKeyInCookie}}
if ctx != nil {
// API Key Authentication
if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
if auth, ok := ctx.Value(Context{{name}}).(APIKey); ok {
var key string
if auth.Prefix != "" {
key = auth.Prefix + " " + auth.Key
Expand Down
6 changes: 5 additions & 1 deletion modules/openapi-generator/src/main/resources/go/configuration.mustache
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,11 @@ var (
ContextAccessToken = contextKey("accesstoken")

// ContextAPIKey takes an APIKey as authentication for the request
ContextAPIKey = contextKey("apikey")
{{#authMethods}}
{{#isApiKey}}
Context{{name}} = contextKey("{{name}}")

@wing328wing328Jun 25, 2019

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like this line is not indented correctly (1 additional tab)

@wing328wing328Jun 25, 2019•
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And what about making ContextAPIKey a map instead as that's what we do in other languages?

{{/isApiKey}}
{{/authMethods}}
)

// BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
Expand Down
4 changes: 2 additions & 2 deletions samples/client/petstore/go/auth_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -133,7 +133,7 @@ func TestAccessToken(t *testing.T) {
}

func TestAPIKeyNoPrefix(t *testing.T) {
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{Key: "TEST123"})
auth := context.WithValue(context.Background(), sw.Contextapi_key, sw.APIKey{Key: "TEST123"})

newPet := (sw.Pet{Id: 12992, Name: "gopher",
PhotoUrls: []string{"http://1.com", "http://2.com"}, Status: "pending", Tags: []sw.Tag{sw.Tag{Id: 1, Name: "tag2"}}})
Expand DownExpand Up@@ -170,7 +170,7 @@ func TestAPIKeyNoPrefix(t *testing.T) {
}

func TestAPIKeyWithPrefix(t *testing.T) {
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{Key: "TEST123", Prefix: "Bearer"})
auth := context.WithValue(context.Background(), sw.Contextapi_key, sw.APIKey{Key: "TEST123", Prefix: "Bearer"})

newPet := (sw.Pet{Id: 12992, Name: "gopher",
PhotoUrls: []string{"http://1.com", "http://2.com"}, Status: "pending", Tags: []sw.Tag{sw.Tag{Id: 1, Name: "tag2"}}})
Expand Down
2 changes: 1 addition & 1 deletion samples/client/petstore/go/go-petstore/api_fake_classname_tags123.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -68,7 +68,7 @@ func (a *FakeClassnameTags123ApiService) TestClassname(ctx context.Context, body
localVarPostBody = &body
if ctx != nil {
// API Key Authentication
if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
if auth, ok := ctx.Value(Contextapi_key_query).(APIKey); ok {
var key string
if auth.Prefix != "" {
key = auth.Prefix + " " + auth.Key
Expand Down
2 changes: 1 addition & 1 deletion samples/client/petstore/go/go-petstore/api_pet.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -390,7 +390,7 @@ func (a *PetApiService) GetPetById(ctx context.Context, petId int64) (Pet, *http
}
if ctx != nil {
// API Key Authentication
if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
if auth, ok := ctx.Value(Contextapi_key).(APIKey); ok {
var key string
if auth.Prefix != "" {
key = auth.Prefix + " " + auth.Key
Expand Down
2 changes: 1 addition & 1 deletion samples/client/petstore/go/go-petstore/api_store.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,7 @@ func (a *StoreApiService) GetInventory(ctx context.Context) (map[string]int32, *
}
if ctx != nil {
// API Key Authentication
if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
if auth, ok := ctx.Value(Contextapi_key).(APIKey); ok {
var key string
if auth.Prefix != "" {
key = auth.Prefix + " " + auth.Key
Expand Down
3 changes: 2 additions & 1 deletion samples/client/petstore/go/go-petstore/configuration.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,8 @@ var (
ContextAccessToken = contextKey("accesstoken")

// ContextAPIKey takes an APIKey as authentication for the request
ContextAPIKey = contextKey("apikey")
Contextapi_key = contextKey("api_key")
Contextapi_key_query = contextKey("api_key_query")
)

// BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
Expand Down
2 changes: 1 addition & 1 deletion samples/openapi3/client/petstore/go/go-petstore/.openapi-generator/VERSION
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
4.0.0-SNAPSHOT
4.0.3-SNAPSHOT
50 changes: 39 additions & 11 deletions samples/openapi3/client/petstore/go/go-petstore/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,16 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat
## Installation

Install the following dependencies:
```

```shell
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional
```

Put the package under your project folder and add the following in import:

```golang
import "./petstore"
```
Expand DownExpand Up@@ -79,10 +81,12 @@ Class | Method | HTTP request | Description
- [ArrayTest](docs/ArrayTest.md)
- [Capitalization](docs/Capitalization.md)
- [Cat](docs/Cat.md)
- [CatAllOf](docs/CatAllOf.md)
- [Category](docs/Category.md)
- [ClassModel](docs/ClassModel.md)
- [Client](docs/Client.md)
- [Dog](docs/Dog.md)
- [DogAllOf](docs/DogAllOf.md)
- [EnumArrays](docs/EnumArrays.md)
- [EnumClass](docs/EnumClass.md)
- [EnumTest](docs/EnumTest.md)
Expand All@@ -104,6 +108,7 @@ Class | Method | HTTP request | Description
- [MixedPropertiesAndAdditionalPropertiesClass](docs/MixedPropertiesAndAdditionalPropertiesClass.md)
- [Model200Response](docs/Model200Response.md)
- [Name](docs/Name.md)
- [NullableClass](docs/NullableClass.md)
- [NumberOnly](docs/NumberOnly.md)
- [Order](docs/Order.md)
- [OuterComposite](docs/OuterComposite.md)
Expand All@@ -121,51 +126,71 @@ Class | Method | HTTP request | Description

## Documentation For Authorization



## api_key
- **Type**: API key

- **Type**: API key

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
```


## api_key_query
- **Type**: API key

- **Type**: API key

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
```


## bearer_test

- **Type**: HTTP basic authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```


## http_basic_test

- **Type**: HTTP basic authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```


## petstore_auth


- **Type**: OAuth
- **Flow**: implicit
- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog
Expand All@@ -174,12 +199,14 @@ r, err := client.Service.Operation(auth, args)
- **read:pets**: read your pets

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
```

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

```golang
import "golang.org/x/oauth2"

Expand All@@ -190,6 +217,7 @@ auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
```


## Author


Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[Golang] Support multiple APIKeys by nmuesch · Pull Request #3210 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Golang] Support multiple APIKeys#3210

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

nmuesch
wants to merge
4
commits into

from

 Closed


[Golang] Support multiple APIKeys
#3210
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
dae864a

Support multiple API Keys


nmuesch Jun 21, 2019
391e7d8

Multiple context approach


nmuesch Jun 21, 2019
31620d3

Update sample


nmuesch Jun 24, 2019
564f4b0

Fix test failures


nmuesch Jun 24, 2019

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


2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/go/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -238,7 +238,7 @@ func (a *{{{classname}}}Service) {{{nickname}}}(ctx context.Context{{#hasParams}
{{^isKeyInCookie}}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Context{{name}}).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

6 changes: 5 additions & 1 deletion
modules/openapi-generator/src/main/resources/go/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,11 @@ var (
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
	{{#authMethods}}
 {{#isApiKey}}
 Context{{name}} = contextKey("{{name}}")
@wing328wing328Jun 25, 2019

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like this line is not indented correctly (1 additional tab)
@wing328wing328Jun 25, 2019•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And what about making ContextAPIKey a map instead as that's what we do in other languages?
 {{/isApiKey}}
	{{/authMethods}}
)

// BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
Expand Down

4 changes: 2 additions & 2 deletions
samples/client/petstore/go/auth_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -133,7 +133,7 @@ func TestAccessToken(t *testing.T) {
}

func TestAPIKeyNoPrefix(t *testing.T) {
	auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{Key: "TEST123"})
	auth := context.WithValue(context.Background(), sw.Contextapi_key, sw.APIKey{Key: "TEST123"})

	newPet := (sw.Pet{Id: 12992, Name: "gopher",
 PhotoUrls: []string{"http://1.com", "http://2.com"}, Status: "pending", Tags: []sw.Tag{sw.Tag{Id: 1, Name: "tag2"}}})
Expand DownExpand Up@@ -170,7 +170,7 @@ func TestAPIKeyNoPrefix(t *testing.T) {
}

func TestAPIKeyWithPrefix(t *testing.T) {
	auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{Key: "TEST123", Prefix: "Bearer"})
	auth := context.WithValue(context.Background(), sw.Contextapi_key, sw.APIKey{Key: "TEST123", Prefix: "Bearer"})

	newPet := (sw.Pet{Id: 12992, Name: "gopher",
 PhotoUrls: []string{"http://1.com", "http://2.com"}, Status: "pending", Tags: []sw.Tag{sw.Tag{Id: 1, Name: "tag2"}}})
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_fake_classname_tags123.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,7 +68,7 @@ func (a *FakeClassnameTags123ApiService) TestClassname(ctx context.Context, body
	localVarPostBody = &body
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key_query).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_pet.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -390,7 +390,7 @@ func (a *PetApiService) GetPetById(ctx context.Context, petId int64) (Pet, *http
	}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_store.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,7 @@ func (a *StoreApiService) GetInventory(ctx context.Context) (map[string]int32, *
	}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

3 changes: 2 additions & 1 deletion
samples/client/petstore/go/go-petstore/configuration.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,8 @@ var (
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
 Contextapi_key = contextKey("api_key")
 Contextapi_key_query = contextKey("api_key_query")
)

// BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
Expand Down

2 changes: 1 addition & 1 deletion
samples/openapi3/client/petstore/go/go-petstore/.openapi-generator/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
4.0.0-SNAPSHOT
4.0.3-SNAPSHOT

50 changes: 39 additions & 11 deletions
samples/openapi3/client/petstore/go/go-petstore/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,16 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat
## Installation

Install the following dependencies:
```

```shell
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional
```

Put the package under your project folder and add the following in import:

```golang
import "./petstore"
```
Expand DownExpand Up@@ -79,10 +81,12 @@ Class | Method | HTTP request | Description
 - [ArrayTest](docs/ArrayTest.md)
 - [Capitalization](docs/Capitalization.md)
 - [Cat](docs/Cat.md)
 - [CatAllOf](docs/CatAllOf.md)
 - [Category](docs/Category.md)
 - [ClassModel](docs/ClassModel.md)
 - [Client](docs/Client.md)
 - [Dog](docs/Dog.md)
 - [DogAllOf](docs/DogAllOf.md)
 - [EnumArrays](docs/EnumArrays.md)
 - [EnumClass](docs/EnumClass.md)
 - [EnumTest](docs/EnumTest.md)
Expand All@@ -104,6 +108,7 @@ Class | Method | HTTP request | Description
 - [MixedPropertiesAndAdditionalPropertiesClass](docs/MixedPropertiesAndAdditionalPropertiesClass.md)
 - [Model200Response](docs/Model200Response.md)
 - [Name](docs/Name.md)
 - [NullableClass](docs/NullableClass.md)
 - [NumberOnly](docs/NumberOnly.md)
 - [Order](docs/Order.md)
 - [OuterComposite](docs/OuterComposite.md)
Expand All@@ -121,51 +126,71 @@ Class | Method | HTTP request | Description

## Documentation For Authorization



## api_key
- **Type**: API key 

- **Type**: API key

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
```


## api_key_query
- **Type**: API key 

- **Type**: API key

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
```


## bearer_test

- **Type**: HTTP basic authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```


## http_basic_test

- **Type**: HTTP basic authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```


## petstore_auth


- **Type**: OAuth
- **Flow**: implicit
- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog
Expand All@@ -174,12 +199,14 @@ r, err := client.Service.Operation(auth, args)
 - **read:pets**: read your pets

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
```

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

```golang
import "golang.org/x/oauth2"

Expand All@@ -190,6 +217,7 @@ auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
```


## Author


Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Golang] Support multiple APIKeys by nmuesch · Pull Request #3210 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Golang] Support multiple APIKeys#3210

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

nmuesch
wants to merge
4
commits into

from

 Closed


[Golang] Support multiple APIKeys
#3210
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
dae864a

Support multiple API Keys


nmuesch Jun 21, 2019
391e7d8

Multiple context approach


nmuesch Jun 21, 2019
31620d3

Update sample


nmuesch Jun 24, 2019
564f4b0

Fix test failures


nmuesch Jun 24, 2019

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


2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/go/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -238,7 +238,7 @@ func (a *{{{classname}}}Service) {{{nickname}}}(ctx context.Context{{#hasParams}
{{^isKeyInCookie}}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Context{{name}}).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

6 changes: 5 additions & 1 deletion
modules/openapi-generator/src/main/resources/go/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,11 @@ var (
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
	{{#authMethods}}
 {{#isApiKey}}
 Context{{name}} = contextKey("{{name}}")
@wing328wing328Jun 25, 2019

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like this line is not indented correctly (1 additional tab)
@wing328wing328Jun 25, 2019•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And what about making ContextAPIKey a map instead as that's what we do in other languages?
 {{/isApiKey}}
	{{/authMethods}}
)

// BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
Expand Down

4 changes: 2 additions & 2 deletions
samples/client/petstore/go/auth_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -133,7 +133,7 @@ func TestAccessToken(t *testing.T) {
}

func TestAPIKeyNoPrefix(t *testing.T) {
	auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{Key: "TEST123"})
	auth := context.WithValue(context.Background(), sw.Contextapi_key, sw.APIKey{Key: "TEST123"})

	newPet := (sw.Pet{Id: 12992, Name: "gopher",
 PhotoUrls: []string{"http://1.com", "http://2.com"}, Status: "pending", Tags: []sw.Tag{sw.Tag{Id: 1, Name: "tag2"}}})
Expand DownExpand Up@@ -170,7 +170,7 @@ func TestAPIKeyNoPrefix(t *testing.T) {
}

func TestAPIKeyWithPrefix(t *testing.T) {
	auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{Key: "TEST123", Prefix: "Bearer"})
	auth := context.WithValue(context.Background(), sw.Contextapi_key, sw.APIKey{Key: "TEST123", Prefix: "Bearer"})

	newPet := (sw.Pet{Id: 12992, Name: "gopher",
 PhotoUrls: []string{"http://1.com", "http://2.com"}, Status: "pending", Tags: []sw.Tag{sw.Tag{Id: 1, Name: "tag2"}}})
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_fake_classname_tags123.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,7 +68,7 @@ func (a *FakeClassnameTags123ApiService) TestClassname(ctx context.Context, body
	localVarPostBody = &body
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key_query).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_pet.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -390,7 +390,7 @@ func (a *PetApiService) GetPetById(ctx context.Context, petId int64) (Pet, *http
	}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_store.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,7 @@ func (a *StoreApiService) GetInventory(ctx context.Context) (map[string]int32, *
	}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

3 changes: 2 additions & 1 deletion
samples/client/petstore/go/go-petstore/configuration.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,8 @@ var (
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
 Contextapi_key = contextKey("api_key")
 Contextapi_key_query = contextKey("api_key_query")
)

// BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
Expand Down

2 changes: 1 addition & 1 deletion
samples/openapi3/client/petstore/go/go-petstore/.openapi-generator/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
4.0.0-SNAPSHOT
4.0.3-SNAPSHOT

50 changes: 39 additions & 11 deletions
samples/openapi3/client/petstore/go/go-petstore/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,16 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat
## Installation

Install the following dependencies:
```

```shell
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional
```

Put the package under your project folder and add the following in import:

```golang
import "./petstore"
```
Expand DownExpand Up@@ -79,10 +81,12 @@ Class | Method | HTTP request | Description
 - [ArrayTest](docs/ArrayTest.md)
 - [Capitalization](docs/Capitalization.md)
 - [Cat](docs/Cat.md)
 - [CatAllOf](docs/CatAllOf.md)
 - [Category](docs/Category.md)
 - [ClassModel](docs/ClassModel.md)
 - [Client](docs/Client.md)
 - [Dog](docs/Dog.md)
 - [DogAllOf](docs/DogAllOf.md)
 - [EnumArrays](docs/EnumArrays.md)
 - [EnumClass](docs/EnumClass.md)
 - [EnumTest](docs/EnumTest.md)
Expand All@@ -104,6 +108,7 @@ Class | Method | HTTP request | Description
 - [MixedPropertiesAndAdditionalPropertiesClass](docs/MixedPropertiesAndAdditionalPropertiesClass.md)
 - [Model200Response](docs/Model200Response.md)
 - [Name](docs/Name.md)
 - [NullableClass](docs/NullableClass.md)
 - [NumberOnly](docs/NumberOnly.md)
 - [Order](docs/Order.md)
 - [OuterComposite](docs/OuterComposite.md)
Expand All@@ -121,51 +126,71 @@ Class | Method | HTTP request | Description

## Documentation For Authorization



## api_key
- **Type**: API key 

- **Type**: API key

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
```


## api_key_query
- **Type**: API key 

- **Type**: API key

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
```


## bearer_test

- **Type**: HTTP basic authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```


## http_basic_test

- **Type**: HTTP basic authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```


## petstore_auth


- **Type**: OAuth
- **Flow**: implicit
- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog
Expand All@@ -174,12 +199,14 @@ r, err := client.Service.Operation(auth, args)
 - **read:pets**: read your pets

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
```

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

```golang
import "golang.org/x/oauth2"

Expand All@@ -190,6 +217,7 @@ auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
```


## Author


Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Golang] Support multiple APIKeys by nmuesch · Pull Request #3210 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Golang] Support multiple APIKeys#3210

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

nmuesch
wants to merge
4
commits into

from

 Closed


[Golang] Support multiple APIKeys
#3210
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
dae864a

Support multiple API Keys


nmuesch Jun 21, 2019
391e7d8

Multiple context approach


nmuesch Jun 21, 2019
31620d3

Update sample


nmuesch Jun 24, 2019
564f4b0

Fix test failures


nmuesch Jun 24, 2019

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


2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/go/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -238,7 +238,7 @@ func (a *{{{classname}}}Service) {{{nickname}}}(ctx context.Context{{#hasParams}
{{^isKeyInCookie}}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Context{{name}}).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

6 changes: 5 additions & 1 deletion
modules/openapi-generator/src/main/resources/go/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,11 @@ var (
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
	{{#authMethods}}
 {{#isApiKey}}
 Context{{name}} = contextKey("{{name}}")
@wing328wing328Jun 25, 2019

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like this line is not indented correctly (1 additional tab)
@wing328wing328Jun 25, 2019•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And what about making ContextAPIKey a map instead as that's what we do in other languages?
 {{/isApiKey}}
	{{/authMethods}}
)

// BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
Expand Down

4 changes: 2 additions & 2 deletions
samples/client/petstore/go/auth_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -133,7 +133,7 @@ func TestAccessToken(t *testing.T) {
}

func TestAPIKeyNoPrefix(t *testing.T) {
	auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{Key: "TEST123"})
	auth := context.WithValue(context.Background(), sw.Contextapi_key, sw.APIKey{Key: "TEST123"})

	newPet := (sw.Pet{Id: 12992, Name: "gopher",
 PhotoUrls: []string{"http://1.com", "http://2.com"}, Status: "pending", Tags: []sw.Tag{sw.Tag{Id: 1, Name: "tag2"}}})
Expand DownExpand Up@@ -170,7 +170,7 @@ func TestAPIKeyNoPrefix(t *testing.T) {
}

func TestAPIKeyWithPrefix(t *testing.T) {
	auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{Key: "TEST123", Prefix: "Bearer"})
	auth := context.WithValue(context.Background(), sw.Contextapi_key, sw.APIKey{Key: "TEST123", Prefix: "Bearer"})

	newPet := (sw.Pet{Id: 12992, Name: "gopher",
 PhotoUrls: []string{"http://1.com", "http://2.com"}, Status: "pending", Tags: []sw.Tag{sw.Tag{Id: 1, Name: "tag2"}}})
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_fake_classname_tags123.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,7 +68,7 @@ func (a *FakeClassnameTags123ApiService) TestClassname(ctx context.Context, body
	localVarPostBody = &body
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key_query).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_pet.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -390,7 +390,7 @@ func (a *PetApiService) GetPetById(ctx context.Context, petId int64) (Pet, *http
	}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_store.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,7 @@ func (a *StoreApiService) GetInventory(ctx context.Context) (map[string]int32, *
	}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

3 changes: 2 additions & 1 deletion
samples/client/petstore/go/go-petstore/configuration.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,8 @@ var (
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
 Contextapi_key = contextKey("api_key")
 Contextapi_key_query = contextKey("api_key_query")
)

// BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
Expand Down

2 changes: 1 addition & 1 deletion
samples/openapi3/client/petstore/go/go-petstore/.openapi-generator/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
4.0.0-SNAPSHOT
4.0.3-SNAPSHOT

50 changes: 39 additions & 11 deletions
samples/openapi3/client/petstore/go/go-petstore/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,16 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat
## Installation

Install the following dependencies:
```

```shell
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional
```

Put the package under your project folder and add the following in import:

```golang
import "./petstore"
```
Expand DownExpand Up@@ -79,10 +81,12 @@ Class | Method | HTTP request | Description
 - [ArrayTest](docs/ArrayTest.md)
 - [Capitalization](docs/Capitalization.md)
 - [Cat](docs/Cat.md)
 - [CatAllOf](docs/CatAllOf.md)
 - [Category](docs/Category.md)
 - [ClassModel](docs/ClassModel.md)
 - [Client](docs/Client.md)
 - [Dog](docs/Dog.md)
 - [DogAllOf](docs/DogAllOf.md)
 - [EnumArrays](docs/EnumArrays.md)
 - [EnumClass](docs/EnumClass.md)
 - [EnumTest](docs/EnumTest.md)
Expand All@@ -104,6 +108,7 @@ Class | Method | HTTP request | Description
 - [MixedPropertiesAndAdditionalPropertiesClass](docs/MixedPropertiesAndAdditionalPropertiesClass.md)
 - [Model200Response](docs/Model200Response.md)
 - [Name](docs/Name.md)
 - [NullableClass](docs/NullableClass.md)
 - [NumberOnly](docs/NumberOnly.md)
 - [Order](docs/Order.md)
 - [OuterComposite](docs/OuterComposite.md)
Expand All@@ -121,51 +126,71 @@ Class | Method | HTTP request | Description

## Documentation For Authorization



## api_key
- **Type**: API key 

- **Type**: API key

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
```


## api_key_query
- **Type**: API key 

- **Type**: API key

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
```


## bearer_test

- **Type**: HTTP basic authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```


## http_basic_test

- **Type**: HTTP basic authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```


## petstore_auth


- **Type**: OAuth
- **Flow**: implicit
- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog
Expand All@@ -174,12 +199,14 @@ r, err := client.Service.Operation(auth, args)
 - **read:pets**: read your pets

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
```

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

```golang
import "golang.org/x/oauth2"

Expand All@@ -190,6 +217,7 @@ auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
```


## Author


Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
[Golang] Support multiple APIKeys by nmuesch · Pull Request #3210 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Golang] Support multiple APIKeys#3210

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

nmuesch
wants to merge
4
commits into

from

 Closed


[Golang] Support multiple APIKeys
#3210
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
dae864a

Support multiple API Keys


nmuesch Jun 21, 2019
391e7d8

Multiple context approach


nmuesch Jun 21, 2019
31620d3

Update sample


nmuesch Jun 24, 2019
564f4b0

Fix test failures


nmuesch Jun 24, 2019

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


2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/go/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -238,7 +238,7 @@ func (a *{{{classname}}}Service) {{{nickname}}}(ctx context.Context{{#hasParams}
{{^isKeyInCookie}}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Context{{name}}).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

6 changes: 5 additions & 1 deletion
modules/openapi-generator/src/main/resources/go/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,11 @@ var (
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
	{{#authMethods}}
 {{#isApiKey}}
 Context{{name}} = contextKey("{{name}}")
@wing328wing328Jun 25, 2019

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like this line is not indented correctly (1 additional tab)
@wing328wing328Jun 25, 2019•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And what about making ContextAPIKey a map instead as that's what we do in other languages?
 {{/isApiKey}}
	{{/authMethods}}
)

// BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
Expand Down

4 changes: 2 additions & 2 deletions
samples/client/petstore/go/auth_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -133,7 +133,7 @@ func TestAccessToken(t *testing.T) {
}

func TestAPIKeyNoPrefix(t *testing.T) {
	auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{Key: "TEST123"})
	auth := context.WithValue(context.Background(), sw.Contextapi_key, sw.APIKey{Key: "TEST123"})

	newPet := (sw.Pet{Id: 12992, Name: "gopher",
 PhotoUrls: []string{"http://1.com", "http://2.com"}, Status: "pending", Tags: []sw.Tag{sw.Tag{Id: 1, Name: "tag2"}}})
Expand DownExpand Up@@ -170,7 +170,7 @@ func TestAPIKeyNoPrefix(t *testing.T) {
}

func TestAPIKeyWithPrefix(t *testing.T) {
	auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{Key: "TEST123", Prefix: "Bearer"})
	auth := context.WithValue(context.Background(), sw.Contextapi_key, sw.APIKey{Key: "TEST123", Prefix: "Bearer"})

	newPet := (sw.Pet{Id: 12992, Name: "gopher",
 PhotoUrls: []string{"http://1.com", "http://2.com"}, Status: "pending", Tags: []sw.Tag{sw.Tag{Id: 1, Name: "tag2"}}})
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_fake_classname_tags123.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,7 +68,7 @@ func (a *FakeClassnameTags123ApiService) TestClassname(ctx context.Context, body
	localVarPostBody = &body
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key_query).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_pet.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -390,7 +390,7 @@ func (a *PetApiService) GetPetById(ctx context.Context, petId int64) (Pet, *http
	}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_store.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,7 @@ func (a *StoreApiService) GetInventory(ctx context.Context) (map[string]int32, *
	}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

3 changes: 2 additions & 1 deletion
samples/client/petstore/go/go-petstore/configuration.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,8 @@ var (
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
 Contextapi_key = contextKey("api_key")
 Contextapi_key_query = contextKey("api_key_query")
)

// BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
Expand Down

2 changes: 1 addition & 1 deletion
samples/openapi3/client/petstore/go/go-petstore/.openapi-generator/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
4.0.0-SNAPSHOT
4.0.3-SNAPSHOT

50 changes: 39 additions & 11 deletions
samples/openapi3/client/petstore/go/go-petstore/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,16 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat
## Installation

Install the following dependencies:
```

```shell
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional
```

Put the package under your project folder and add the following in import:

```golang
import "./petstore"
```
Expand DownExpand Up@@ -79,10 +81,12 @@ Class | Method | HTTP request | Description
 - [ArrayTest](docs/ArrayTest.md)
 - [Capitalization](docs/Capitalization.md)
 - [Cat](docs/Cat.md)
 - [CatAllOf](docs/CatAllOf.md)
 - [Category](docs/Category.md)
 - [ClassModel](docs/ClassModel.md)
 - [Client](docs/Client.md)
 - [Dog](docs/Dog.md)
 - [DogAllOf](docs/DogAllOf.md)
 - [EnumArrays](docs/EnumArrays.md)
 - [EnumClass](docs/EnumClass.md)
 - [EnumTest](docs/EnumTest.md)
Expand All@@ -104,6 +108,7 @@ Class | Method | HTTP request | Description
 - [MixedPropertiesAndAdditionalPropertiesClass](docs/MixedPropertiesAndAdditionalPropertiesClass.md)
 - [Model200Response](docs/Model200Response.md)
 - [Name](docs/Name.md)
 - [NullableClass](docs/NullableClass.md)
 - [NumberOnly](docs/NumberOnly.md)
 - [Order](docs/Order.md)
 - [OuterComposite](docs/OuterComposite.md)
Expand All@@ -121,51 +126,71 @@ Class | Method | HTTP request | Description

## Documentation For Authorization



## api_key
- **Type**: API key 

- **Type**: API key

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
```


## api_key_query
- **Type**: API key 

- **Type**: API key

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
```


## bearer_test

- **Type**: HTTP basic authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```


## http_basic_test

- **Type**: HTTP basic authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```


## petstore_auth


- **Type**: OAuth
- **Flow**: implicit
- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog
Expand All@@ -174,12 +199,14 @@ r, err := client.Service.Operation(auth, args)
 - **read:pets**: read your pets

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
```

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

```golang
import "golang.org/x/oauth2"

Expand All@@ -190,6 +217,7 @@ auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
```


## Author


Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Golang] Support multiple APIKeys by nmuesch · Pull Request #3210 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Golang] Support multiple APIKeys#3210

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

nmuesch
wants to merge
4
commits into

from

 Closed


[Golang] Support multiple APIKeys
#3210
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
dae864a

Support multiple API Keys


nmuesch Jun 21, 2019
391e7d8

Multiple context approach


nmuesch Jun 21, 2019
31620d3

Update sample


nmuesch Jun 24, 2019
564f4b0

Fix test failures


nmuesch Jun 24, 2019

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


2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/go/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -238,7 +238,7 @@ func (a *{{{classname}}}Service) {{{nickname}}}(ctx context.Context{{#hasParams}
{{^isKeyInCookie}}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Context{{name}}).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

6 changes: 5 additions & 1 deletion
modules/openapi-generator/src/main/resources/go/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,11 @@ var (
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
	{{#authMethods}}
 {{#isApiKey}}
 Context{{name}} = contextKey("{{name}}")
@wing328wing328Jun 25, 2019

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like this line is not indented correctly (1 additional tab)
@wing328wing328Jun 25, 2019•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And what about making ContextAPIKey a map instead as that's what we do in other languages?
 {{/isApiKey}}
	{{/authMethods}}
)

// BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
Expand Down

4 changes: 2 additions & 2 deletions
samples/client/petstore/go/auth_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -133,7 +133,7 @@ func TestAccessToken(t *testing.T) {
}

func TestAPIKeyNoPrefix(t *testing.T) {
	auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{Key: "TEST123"})
	auth := context.WithValue(context.Background(), sw.Contextapi_key, sw.APIKey{Key: "TEST123"})

	newPet := (sw.Pet{Id: 12992, Name: "gopher",
 PhotoUrls: []string{"http://1.com", "http://2.com"}, Status: "pending", Tags: []sw.Tag{sw.Tag{Id: 1, Name: "tag2"}}})
Expand DownExpand Up@@ -170,7 +170,7 @@ func TestAPIKeyNoPrefix(t *testing.T) {
}

func TestAPIKeyWithPrefix(t *testing.T) {
	auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{Key: "TEST123", Prefix: "Bearer"})
	auth := context.WithValue(context.Background(), sw.Contextapi_key, sw.APIKey{Key: "TEST123", Prefix: "Bearer"})

	newPet := (sw.Pet{Id: 12992, Name: "gopher",
 PhotoUrls: []string{"http://1.com", "http://2.com"}, Status: "pending", Tags: []sw.Tag{sw.Tag{Id: 1, Name: "tag2"}}})
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_fake_classname_tags123.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,7 +68,7 @@ func (a *FakeClassnameTags123ApiService) TestClassname(ctx context.Context, body
	localVarPostBody = &body
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key_query).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_pet.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -390,7 +390,7 @@ func (a *PetApiService) GetPetById(ctx context.Context, petId int64) (Pet, *http
	}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_store.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,7 @@ func (a *StoreApiService) GetInventory(ctx context.Context) (map[string]int32, *
	}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

3 changes: 2 additions & 1 deletion
samples/client/petstore/go/go-petstore/configuration.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,8 @@ var (
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
 Contextapi_key = contextKey("api_key")
 Contextapi_key_query = contextKey("api_key_query")
)

// BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
Expand Down

2 changes: 1 addition & 1 deletion
samples/openapi3/client/petstore/go/go-petstore/.openapi-generator/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
4.0.0-SNAPSHOT
4.0.3-SNAPSHOT

50 changes: 39 additions & 11 deletions
samples/openapi3/client/petstore/go/go-petstore/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,16 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat
## Installation

Install the following dependencies:
```

```shell
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional
```

Put the package under your project folder and add the following in import:

```golang
import "./petstore"
```
Expand DownExpand Up@@ -79,10 +81,12 @@ Class | Method | HTTP request | Description
 - [ArrayTest](docs/ArrayTest.md)
 - [Capitalization](docs/Capitalization.md)
 - [Cat](docs/Cat.md)
 - [CatAllOf](docs/CatAllOf.md)
 - [Category](docs/Category.md)
 - [ClassModel](docs/ClassModel.md)
 - [Client](docs/Client.md)
 - [Dog](docs/Dog.md)
 - [DogAllOf](docs/DogAllOf.md)
 - [EnumArrays](docs/EnumArrays.md)
 - [EnumClass](docs/EnumClass.md)
 - [EnumTest](docs/EnumTest.md)
Expand All@@ -104,6 +108,7 @@ Class | Method | HTTP request | Description
 - [MixedPropertiesAndAdditionalPropertiesClass](docs/MixedPropertiesAndAdditionalPropertiesClass.md)
 - [Model200Response](docs/Model200Response.md)
 - [Name](docs/Name.md)
 - [NullableClass](docs/NullableClass.md)
 - [NumberOnly](docs/NumberOnly.md)
 - [Order](docs/Order.md)
 - [OuterComposite](docs/OuterComposite.md)
Expand All@@ -121,51 +126,71 @@ Class | Method | HTTP request | Description

## Documentation For Authorization



## api_key
- **Type**: API key 

- **Type**: API key

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
```


## api_key_query
- **Type**: API key 

- **Type**: API key

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
```


## bearer_test

- **Type**: HTTP basic authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```


## http_basic_test

- **Type**: HTTP basic authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```


## petstore_auth


- **Type**: OAuth
- **Flow**: implicit
- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog
Expand All@@ -174,12 +199,14 @@ r, err := client.Service.Operation(auth, args)
 - **read:pets**: read your pets

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
```

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

```golang
import "golang.org/x/oauth2"

Expand All@@ -190,6 +217,7 @@ auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
```


## Author


Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[Golang] Support multiple APIKeys by nmuesch · Pull Request #3210 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Golang] Support multiple APIKeys#3210

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

nmuesch
wants to merge
4
commits into

from

 Closed


[Golang] Support multiple APIKeys
#3210
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
dae864a

Support multiple API Keys


nmuesch Jun 21, 2019
391e7d8

Multiple context approach


nmuesch Jun 21, 2019
31620d3

Update sample


nmuesch Jun 24, 2019
564f4b0

Fix test failures


nmuesch Jun 24, 2019

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


2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/go/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -238,7 +238,7 @@ func (a *{{{classname}}}Service) {{{nickname}}}(ctx context.Context{{#hasParams}
{{^isKeyInCookie}}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Context{{name}}).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

6 changes: 5 additions & 1 deletion
modules/openapi-generator/src/main/resources/go/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,11 @@ var (
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
	{{#authMethods}}
 {{#isApiKey}}
 Context{{name}} = contextKey("{{name}}")
@wing328wing328Jun 25, 2019

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like this line is not indented correctly (1 additional tab)
@wing328wing328Jun 25, 2019•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And what about making ContextAPIKey a map instead as that's what we do in other languages?
 {{/isApiKey}}
	{{/authMethods}}
)

// BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
Expand Down

4 changes: 2 additions & 2 deletions
samples/client/petstore/go/auth_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -133,7 +133,7 @@ func TestAccessToken(t *testing.T) {
}

func TestAPIKeyNoPrefix(t *testing.T) {
	auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{Key: "TEST123"})
	auth := context.WithValue(context.Background(), sw.Contextapi_key, sw.APIKey{Key: "TEST123"})

	newPet := (sw.Pet{Id: 12992, Name: "gopher",
 PhotoUrls: []string{"http://1.com", "http://2.com"}, Status: "pending", Tags: []sw.Tag{sw.Tag{Id: 1, Name: "tag2"}}})
Expand DownExpand Up@@ -170,7 +170,7 @@ func TestAPIKeyNoPrefix(t *testing.T) {
}

func TestAPIKeyWithPrefix(t *testing.T) {
	auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{Key: "TEST123", Prefix: "Bearer"})
	auth := context.WithValue(context.Background(), sw.Contextapi_key, sw.APIKey{Key: "TEST123", Prefix: "Bearer"})

	newPet := (sw.Pet{Id: 12992, Name: "gopher",
 PhotoUrls: []string{"http://1.com", "http://2.com"}, Status: "pending", Tags: []sw.Tag{sw.Tag{Id: 1, Name: "tag2"}}})
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_fake_classname_tags123.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,7 +68,7 @@ func (a *FakeClassnameTags123ApiService) TestClassname(ctx context.Context, body
	localVarPostBody = &body
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key_query).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_pet.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -390,7 +390,7 @@ func (a *PetApiService) GetPetById(ctx context.Context, petId int64) (Pet, *http
	}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_store.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,7 @@ func (a *StoreApiService) GetInventory(ctx context.Context) (map[string]int32, *
	}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

3 changes: 2 additions & 1 deletion
samples/client/petstore/go/go-petstore/configuration.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,8 @@ var (
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
 Contextapi_key = contextKey("api_key")
 Contextapi_key_query = contextKey("api_key_query")
)

// BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
Expand Down

2 changes: 1 addition & 1 deletion
samples/openapi3/client/petstore/go/go-petstore/.openapi-generator/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
4.0.0-SNAPSHOT
4.0.3-SNAPSHOT

50 changes: 39 additions & 11 deletions
samples/openapi3/client/petstore/go/go-petstore/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,16 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat
## Installation

Install the following dependencies:
```

```shell
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional
```

Put the package under your project folder and add the following in import:

```golang
import "./petstore"
```
Expand DownExpand Up@@ -79,10 +81,12 @@ Class | Method | HTTP request | Description
 - [ArrayTest](docs/ArrayTest.md)
 - [Capitalization](docs/Capitalization.md)
 - [Cat](docs/Cat.md)
 - [CatAllOf](docs/CatAllOf.md)
 - [Category](docs/Category.md)
 - [ClassModel](docs/ClassModel.md)
 - [Client](docs/Client.md)
 - [Dog](docs/Dog.md)
 - [DogAllOf](docs/DogAllOf.md)
 - [EnumArrays](docs/EnumArrays.md)
 - [EnumClass](docs/EnumClass.md)
 - [EnumTest](docs/EnumTest.md)
Expand All@@ -104,6 +108,7 @@ Class | Method | HTTP request | Description
 - [MixedPropertiesAndAdditionalPropertiesClass](docs/MixedPropertiesAndAdditionalPropertiesClass.md)
 - [Model200Response](docs/Model200Response.md)
 - [Name](docs/Name.md)
 - [NullableClass](docs/NullableClass.md)
 - [NumberOnly](docs/NumberOnly.md)
 - [Order](docs/Order.md)
 - [OuterComposite](docs/OuterComposite.md)
Expand All@@ -121,51 +126,71 @@ Class | Method | HTTP request | Description

## Documentation For Authorization



## api_key
- **Type**: API key 

- **Type**: API key

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
```


## api_key_query
- **Type**: API key 

- **Type**: API key

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
```


## bearer_test

- **Type**: HTTP basic authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```


## http_basic_test

- **Type**: HTTP basic authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```


## petstore_auth


- **Type**: OAuth
- **Flow**: implicit
- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog
Expand All@@ -174,12 +199,14 @@ r, err := client.Service.Operation(auth, args)
 - **read:pets**: read your pets

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
```

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

```golang
import "golang.org/x/oauth2"

Expand All@@ -190,6 +217,7 @@ auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
```


## Author


Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
[Golang] Support multiple APIKeys by nmuesch · Pull Request #3210 · OpenAPITools/openapi-generator · GitHub
Skip to content
[Golang] Support multiple APIKeys#3210

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

nmuesch
wants to merge
4
commits into

from

 Closed


[Golang] Support multiple APIKeys
#3210
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
dae864a

Support multiple API Keys


nmuesch Jun 21, 2019
391e7d8

Multiple context approach


nmuesch Jun 21, 2019
31620d3

Update sample


nmuesch Jun 24, 2019
564f4b0

Fix test failures


nmuesch Jun 24, 2019

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


2 changes: 1 addition & 1 deletion
modules/openapi-generator/src/main/resources/go/api.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -238,7 +238,7 @@ func (a *{{{classname}}}Service) {{{nickname}}}(ctx context.Context{{#hasParams}
{{^isKeyInCookie}}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Context{{name}}).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

6 changes: 5 additions & 1 deletion
modules/openapi-generator/src/main/resources/go/configuration.mustache

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,11 @@ var (
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
	{{#authMethods}}
 {{#isApiKey}}
 Context{{name}} = contextKey("{{name}}")
@wing328wing328Jun 25, 2019

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like this line is not indented correctly (1 additional tab)
@wing328wing328Jun 25, 2019•

edited

Loading

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And what about making ContextAPIKey a map instead as that's what we do in other languages?
 {{/isApiKey}}
	{{/authMethods}}
)

// BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
Expand Down

4 changes: 2 additions & 2 deletions
samples/client/petstore/go/auth_test.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -133,7 +133,7 @@ func TestAccessToken(t *testing.T) {
}

func TestAPIKeyNoPrefix(t *testing.T) {
	auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{Key: "TEST123"})
	auth := context.WithValue(context.Background(), sw.Contextapi_key, sw.APIKey{Key: "TEST123"})

	newPet := (sw.Pet{Id: 12992, Name: "gopher",
 PhotoUrls: []string{"http://1.com", "http://2.com"}, Status: "pending", Tags: []sw.Tag{sw.Tag{Id: 1, Name: "tag2"}}})
Expand DownExpand Up@@ -170,7 +170,7 @@ func TestAPIKeyNoPrefix(t *testing.T) {
}

func TestAPIKeyWithPrefix(t *testing.T) {
	auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{Key: "TEST123", Prefix: "Bearer"})
	auth := context.WithValue(context.Background(), sw.Contextapi_key, sw.APIKey{Key: "TEST123", Prefix: "Bearer"})

	newPet := (sw.Pet{Id: 12992, Name: "gopher",
 PhotoUrls: []string{"http://1.com", "http://2.com"}, Status: "pending", Tags: []sw.Tag{sw.Tag{Id: 1, Name: "tag2"}}})
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_fake_classname_tags123.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -68,7 +68,7 @@ func (a *FakeClassnameTags123ApiService) TestClassname(ctx context.Context, body
	localVarPostBody = &body
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key_query).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_pet.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -390,7 +390,7 @@ func (a *PetApiService) GetPetById(ctx context.Context, petId int64) (Pet, *http
	}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

2 changes: 1 addition & 1 deletion
samples/client/petstore/go/go-petstore/api_store.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -134,7 +134,7 @@ func (a *StoreApiService) GetInventory(ctx context.Context) (map[string]int32, *
	}
	if ctx != nil {
 // API Key Authentication
 if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok {
 if auth, ok := ctx.Value(Contextapi_key).(APIKey); ok {
 var key string
 if auth.Prefix != "" {
 key = auth.Prefix + " " + auth.Key
Expand Down

3 changes: 2 additions & 1 deletion
samples/client/petstore/go/go-petstore/configuration.go

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,8 @@ var (
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
 Contextapi_key = contextKey("api_key")
 Contextapi_key_query = contextKey("api_key_query")
)

// BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
Expand Down

2 changes: 1 addition & 1 deletion
samples/openapi3/client/petstore/go/go-petstore/.openapi-generator/VERSION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
4.0.0-SNAPSHOT
4.0.3-SNAPSHOT

50 changes: 39 additions & 11 deletions
samples/openapi3/client/petstore/go/go-petstore/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,16 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat
## Installation

Install the following dependencies:
```

```shell
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional
```

Put the package under your project folder and add the following in import:

```golang
import "./petstore"
```
Expand DownExpand Up@@ -79,10 +81,12 @@ Class | Method | HTTP request | Description
 - [ArrayTest](docs/ArrayTest.md)
 - [Capitalization](docs/Capitalization.md)
 - [Cat](docs/Cat.md)
 - [CatAllOf](docs/CatAllOf.md)
 - [Category](docs/Category.md)
 - [ClassModel](docs/ClassModel.md)
 - [Client](docs/Client.md)
 - [Dog](docs/Dog.md)
 - [DogAllOf](docs/DogAllOf.md)
 - [EnumArrays](docs/EnumArrays.md)
 - [EnumClass](docs/EnumClass.md)
 - [EnumTest](docs/EnumTest.md)
Expand All@@ -104,6 +108,7 @@ Class | Method | HTTP request | Description
 - [MixedPropertiesAndAdditionalPropertiesClass](docs/MixedPropertiesAndAdditionalPropertiesClass.md)
 - [Model200Response](docs/Model200Response.md)
 - [Name](docs/Name.md)
 - [NullableClass](docs/NullableClass.md)
 - [NumberOnly](docs/NumberOnly.md)
 - [Order](docs/Order.md)
 - [OuterComposite](docs/OuterComposite.md)
Expand All@@ -121,51 +126,71 @@ Class | Method | HTTP request | Description

## Documentation For Authorization



## api_key
- **Type**: API key 

- **Type**: API key

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
```


## api_key_query
- **Type**: API key 

- **Type**: API key

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)
```


## bearer_test

- **Type**: HTTP basic authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```


## http_basic_test

- **Type**: HTTP basic authentication

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
```


## petstore_auth


- **Type**: OAuth
- **Flow**: implicit
- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog
Expand All@@ -174,12 +199,14 @@ r, err := client.Service.Operation(auth, args)
 - **read:pets**: read your pets

Example

```golang
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
```

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

```golang
import "golang.org/x/oauth2"

Expand All@@ -190,6 +217,7 @@ auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
```


## Author


Expand Down
Loading