Skip to content

feat(dart-dio): add methods to remove auth tokens in api client #23386

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

Merged
wing328 merged 1 commit into from
Apr 1, 2026
Merged

feat(dart-dio): add methods to remove auth tokens in api client #23386

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
40 changes: 40 additions & 0 deletions modules/openapi-generator/src/main/resources/dart/libraries/dio/api_client.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,22 +46,62 @@ class {{clientName}} {
}
}

/// Removes the OAuth token associated with the given [name].
///
/// If no [OAuthInterceptor] is registered or no token exists for the given
/// [name], this method has no effect.
void removeOAuthToken(String name) {
Comment thread
nopjar marked this conversation as resolved.
if (this.dio.interceptors.any((i) => i is OAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is OAuthInterceptor) as OAuthInterceptor).tokens.remove(name);
}
}

void setBearerAuth(String name, String token) {
if (this.dio.interceptors.any((i) => i is BearerAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BearerAuthInterceptor) as BearerAuthInterceptor).tokens[name] = token;
}
}

/// Removes the bearer authentication token associated with the given [name].
///
/// If no [BearerAuthInterceptor] is registered or no token exists for the
/// given [name], this method has no effect.
void removeBearerAuth(String name) {
if (this.dio.interceptors.any((i) => i is BearerAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BearerAuthInterceptor) as BearerAuthInterceptor).tokens.remove(name);
}
}

void setBasicAuth(String name, String username, String password) {
if (this.dio.interceptors.any((i) => i is BasicAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BasicAuthInterceptor) as BasicAuthInterceptor).authInfo[name] = BasicAuthInfo(username, password);
}
}

/// Removes the basic authentication credentials associated with the given [name].
///
/// If no [BasicAuthInterceptor] is registered or no credentials exist for the
/// given [name], this method has no effect.
void removeBasicAuth(String name) {
if (this.dio.interceptors.any((i) => i is BasicAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BasicAuthInterceptor) as BasicAuthInterceptor).authInfo.remove(name);
}
}

void setApiKey(String name, String apiKey) {
if (this.dio.interceptors.any((i) => i is ApiKeyAuthInterceptor)) {
(this.dio.interceptors.firstWhere((element) => element is ApiKeyAuthInterceptor) as ApiKeyAuthInterceptor).apiKeys[name] = apiKey;
}
}

/// Removes the API key associated with the given [name].
///
/// If no [ApiKeyAuthInterceptor] is registered or no API key exists for the
/// given [name], this method has no effect.
void removeApiKey(String name) {
if (this.dio.interceptors.any((i) => i is ApiKeyAuthInterceptor)) {
(this.dio.interceptors.firstWhere((element) => element is ApiKeyAuthInterceptor) as ApiKeyAuthInterceptor).apiKeys.remove(name);
}
}{{#apiInfo}}{{#apis}}

/// Get {{classname}} instance, base route and serializer can be overridden by a given but be careful,
Expand Down
40 changes: 40 additions & 0 deletions samples/openapi3/client/petstore/dart-dio/binary_response/lib/src/api.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,24 +42,64 @@ class Openapi {
}
}

/// Removes the OAuth token associated with the given [name].
///
/// If no [OAuthInterceptor] is registered or no token exists for the given
/// [name], this method has no effect.
void removeOAuthToken(String name) {
if (this.dio.interceptors.any((i) => i is OAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is OAuthInterceptor) as OAuthInterceptor).tokens.remove(name);
}
}

void setBearerAuth(String name, String token) {
if (this.dio.interceptors.any((i) => i is BearerAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BearerAuthInterceptor) as BearerAuthInterceptor).tokens[name] = token;
}
}

/// Removes the bearer authentication token associated with the given [name].
///
/// If no [BearerAuthInterceptor] is registered or no token exists for the
/// given [name], this method has no effect.
void removeBearerAuth(String name) {
if (this.dio.interceptors.any((i) => i is BearerAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BearerAuthInterceptor) as BearerAuthInterceptor).tokens.remove(name);
}
}

void setBasicAuth(String name, String username, String password) {
if (this.dio.interceptors.any((i) => i is BasicAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BasicAuthInterceptor) as BasicAuthInterceptor).authInfo[name] = BasicAuthInfo(username, password);
}
}

/// Removes the basic authentication credentials associated with the given [name].
///
/// If no [BasicAuthInterceptor] is registered or no credentials exist for the
/// given [name], this method has no effect.
void removeBasicAuth(String name) {
if (this.dio.interceptors.any((i) => i is BasicAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BasicAuthInterceptor) as BasicAuthInterceptor).authInfo.remove(name);
}
}

void setApiKey(String name, String apiKey) {
if (this.dio.interceptors.any((i) => i is ApiKeyAuthInterceptor)) {
(this.dio.interceptors.firstWhere((element) => element is ApiKeyAuthInterceptor) as ApiKeyAuthInterceptor).apiKeys[name] = apiKey;
}
}

/// Removes the API key associated with the given [name].
///
/// If no [ApiKeyAuthInterceptor] is registered or no API key exists for the
/// given [name], this method has no effect.
void removeApiKey(String name) {
if (this.dio.interceptors.any((i) => i is ApiKeyAuthInterceptor)) {
(this.dio.interceptors.firstWhere((element) => element is ApiKeyAuthInterceptor) as ApiKeyAuthInterceptor).apiKeys.remove(name);
}
}

/// Get DefaultApi instance, base route and serializer can be overridden by a given but be careful,
/// by doing that all interceptors will not be executed
DefaultApi getDefaultApi() {
Expand Down
40 changes: 40 additions & 0 deletions samples/openapi3/client/petstore/dart-dio/oneof/lib/src/api.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,24 +47,64 @@ class Openapi {
}
}

/// Removes the OAuth token associated with the given [name].
///
/// If no [OAuthInterceptor] is registered or no token exists for the given
/// [name], this method has no effect.
void removeOAuthToken(String name) {
if (this.dio.interceptors.any((i) => i is OAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is OAuthInterceptor) as OAuthInterceptor).tokens.remove(name);
}
}

void setBearerAuth(String name, String token) {
if (this.dio.interceptors.any((i) => i is BearerAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BearerAuthInterceptor) as BearerAuthInterceptor).tokens[name] = token;
}
}

/// Removes the bearer authentication token associated with the given [name].
///
/// If no [BearerAuthInterceptor] is registered or no token exists for the
/// given [name], this method has no effect.
void removeBearerAuth(String name) {
if (this.dio.interceptors.any((i) => i is BearerAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BearerAuthInterceptor) as BearerAuthInterceptor).tokens.remove(name);
}
}

void setBasicAuth(String name, String username, String password) {
if (this.dio.interceptors.any((i) => i is BasicAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BasicAuthInterceptor) as BasicAuthInterceptor).authInfo[name] = BasicAuthInfo(username, password);
}
}

/// Removes the basic authentication credentials associated with the given [name].
///
/// If no [BasicAuthInterceptor] is registered or no credentials exist for the
/// given [name], this method has no effect.
void removeBasicAuth(String name) {
if (this.dio.interceptors.any((i) => i is BasicAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BasicAuthInterceptor) as BasicAuthInterceptor).authInfo.remove(name);
}
}

void setApiKey(String name, String apiKey) {
if (this.dio.interceptors.any((i) => i is ApiKeyAuthInterceptor)) {
(this.dio.interceptors.firstWhere((element) => element is ApiKeyAuthInterceptor) as ApiKeyAuthInterceptor).apiKeys[name] = apiKey;
}
}

/// Removes the API key associated with the given [name].
///
/// If no [ApiKeyAuthInterceptor] is registered or no API key exists for the
/// given [name], this method has no effect.
void removeApiKey(String name) {
if (this.dio.interceptors.any((i) => i is ApiKeyAuthInterceptor)) {
(this.dio.interceptors.firstWhere((element) => element is ApiKeyAuthInterceptor) as ApiKeyAuthInterceptor).apiKeys.remove(name);
}
}

/// Get DefaultApi instance, base route and serializer can be overridden by a given but be careful,
/// by doing that all interceptors will not be executed
DefaultApi getDefaultApi() {
Expand Down
40 changes: 40 additions & 0 deletions ...les/openapi3/client/petstore/dart-dio/oneof_polymorphism_and_inheritance/lib/src/api.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,24 +48,64 @@ class Openapi {
}
}

/// Removes the OAuth token associated with the given [name].
///
/// If no [OAuthInterceptor] is registered or no token exists for the given
/// [name], this method has no effect.
void removeOAuthToken(String name) {
if (this.dio.interceptors.any((i) => i is OAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is OAuthInterceptor) as OAuthInterceptor).tokens.remove(name);
}
}

void setBearerAuth(String name, String token) {
if (this.dio.interceptors.any((i) => i is BearerAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BearerAuthInterceptor) as BearerAuthInterceptor).tokens[name] = token;
}
}

/// Removes the bearer authentication token associated with the given [name].
///
/// If no [BearerAuthInterceptor] is registered or no token exists for the
/// given [name], this method has no effect.
void removeBearerAuth(String name) {
if (this.dio.interceptors.any((i) => i is BearerAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BearerAuthInterceptor) as BearerAuthInterceptor).tokens.remove(name);
}
}

void setBasicAuth(String name, String username, String password) {
if (this.dio.interceptors.any((i) => i is BasicAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BasicAuthInterceptor) as BasicAuthInterceptor).authInfo[name] = BasicAuthInfo(username, password);
}
}

/// Removes the basic authentication credentials associated with the given [name].
///
/// If no [BasicAuthInterceptor] is registered or no credentials exist for the
/// given [name], this method has no effect.
void removeBasicAuth(String name) {
if (this.dio.interceptors.any((i) => i is BasicAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BasicAuthInterceptor) as BasicAuthInterceptor).authInfo.remove(name);
}
}

void setApiKey(String name, String apiKey) {
if (this.dio.interceptors.any((i) => i is ApiKeyAuthInterceptor)) {
(this.dio.interceptors.firstWhere((element) => element is ApiKeyAuthInterceptor) as ApiKeyAuthInterceptor).apiKeys[name] = apiKey;
}
}

/// Removes the API key associated with the given [name].
///
/// If no [ApiKeyAuthInterceptor] is registered or no API key exists for the
/// given [name], this method has no effect.
void removeApiKey(String name) {
if (this.dio.interceptors.any((i) => i is ApiKeyAuthInterceptor)) {
(this.dio.interceptors.firstWhere((element) => element is ApiKeyAuthInterceptor) as ApiKeyAuthInterceptor).apiKeys.remove(name);
}
}

/// Get BarApi instance, base route and serializer can be overridden by a given but be careful,
/// by doing that all interceptors will not be executed
BarApi getBarApi() {
Expand Down
40 changes: 40 additions & 0 deletions samples/openapi3/client/petstore/dart-dio/oneof_primitive/lib/src/api.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,24 +47,64 @@ class Openapi {
}
}

/// Removes the OAuth token associated with the given [name].
///
/// If no [OAuthInterceptor] is registered or no token exists for the given
/// [name], this method has no effect.
void removeOAuthToken(String name) {
if (this.dio.interceptors.any((i) => i is OAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is OAuthInterceptor) as OAuthInterceptor).tokens.remove(name);
}
}

void setBearerAuth(String name, String token) {
if (this.dio.interceptors.any((i) => i is BearerAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BearerAuthInterceptor) as BearerAuthInterceptor).tokens[name] = token;
}
}

/// Removes the bearer authentication token associated with the given [name].
///
/// If no [BearerAuthInterceptor] is registered or no token exists for the
/// given [name], this method has no effect.
void removeBearerAuth(String name) {
if (this.dio.interceptors.any((i) => i is BearerAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BearerAuthInterceptor) as BearerAuthInterceptor).tokens.remove(name);
}
}

void setBasicAuth(String name, String username, String password) {
if (this.dio.interceptors.any((i) => i is BasicAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BasicAuthInterceptor) as BasicAuthInterceptor).authInfo[name] = BasicAuthInfo(username, password);
}
}

/// Removes the basic authentication credentials associated with the given [name].
///
/// If no [BasicAuthInterceptor] is registered or no credentials exist for the
/// given [name], this method has no effect.
void removeBasicAuth(String name) {
if (this.dio.interceptors.any((i) => i is BasicAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BasicAuthInterceptor) as BasicAuthInterceptor).authInfo.remove(name);
}
}

void setApiKey(String name, String apiKey) {
if (this.dio.interceptors.any((i) => i is ApiKeyAuthInterceptor)) {
(this.dio.interceptors.firstWhere((element) => element is ApiKeyAuthInterceptor) as ApiKeyAuthInterceptor).apiKeys[name] = apiKey;
}
}

/// Removes the API key associated with the given [name].
///
/// If no [ApiKeyAuthInterceptor] is registered or no API key exists for the
/// given [name], this method has no effect.
void removeApiKey(String name) {
if (this.dio.interceptors.any((i) => i is ApiKeyAuthInterceptor)) {
(this.dio.interceptors.firstWhere((element) => element is ApiKeyAuthInterceptor) as ApiKeyAuthInterceptor).apiKeys.remove(name);
}
}

/// Get DefaultApi instance, base route and serializer can be overridden by a given but be careful,
/// by doing that all interceptors will not be executed
DefaultApi getDefaultApi() {
Expand Down
40 changes: 40 additions & 0 deletions samples/openapi3/client/petstore/dart-dio/petstore-timemachine/lib/src/api.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,24 +49,64 @@ class Openapi {
}
}

/// Removes the OAuth token associated with the given [name].
///
/// If no [OAuthInterceptor] is registered or no token exists for the given
/// [name], this method has no effect.
void removeOAuthToken(String name) {
if (this.dio.interceptors.any((i) => i is OAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is OAuthInterceptor) as OAuthInterceptor).tokens.remove(name);
}
}

void setBearerAuth(String name, String token) {
if (this.dio.interceptors.any((i) => i is BearerAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BearerAuthInterceptor) as BearerAuthInterceptor).tokens[name] = token;
}
}

/// Removes the bearer authentication token associated with the given [name].
///
/// If no [BearerAuthInterceptor] is registered or no token exists for the
/// given [name], this method has no effect.
void removeBearerAuth(String name) {
if (this.dio.interceptors.any((i) => i is BearerAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BearerAuthInterceptor) as BearerAuthInterceptor).tokens.remove(name);
}
}

void setBasicAuth(String name, String username, String password) {
if (this.dio.interceptors.any((i) => i is BasicAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BasicAuthInterceptor) as BasicAuthInterceptor).authInfo[name] = BasicAuthInfo(username, password);
}
}

/// Removes the basic authentication credentials associated with the given [name].
///
/// If no [BasicAuthInterceptor] is registered or no credentials exist for the
/// given [name], this method has no effect.
void removeBasicAuth(String name) {
if (this.dio.interceptors.any((i) => i is BasicAuthInterceptor)) {
(this.dio.interceptors.firstWhere((i) => i is BasicAuthInterceptor) as BasicAuthInterceptor).authInfo.remove(name);
}
}

void setApiKey(String name, String apiKey) {
if (this.dio.interceptors.any((i) => i is ApiKeyAuthInterceptor)) {
(this.dio.interceptors.firstWhere((element) => element is ApiKeyAuthInterceptor) as ApiKeyAuthInterceptor).apiKeys[name] = apiKey;
}
}

/// Removes the API key associated with the given [name].
///
/// If no [ApiKeyAuthInterceptor] is registered or no API key exists for the
/// given [name], this method has no effect.
void removeApiKey(String name) {
if (this.dio.interceptors.any((i) => i is ApiKeyAuthInterceptor)) {
(this.dio.interceptors.firstWhere((element) => element is ApiKeyAuthInterceptor) as ApiKeyAuthInterceptor).apiKeys.remove(name);
}
}

/// Get PetApi instance, base route and serializer can be overridden by a given but be careful,
/// by doing that all interceptors will not be executed
PetApi getPetApi() {
Expand Down
Loading
Loading