Dmitry
90ba198c2a
openapi-generator-cli -g dart-dio. Генерируется, но коммитится: CI ловит дрейф openapi/openapi.json, а приложение собирается без запуска генератора. Пересобирается через just gen-client после любого изменения роутов.
177 lines
4.1 KiB
Markdown
177 lines
4.1 KiB
Markdown
# fintracker_api.api.AuthApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
```
|
|
|
|
All URIs are relative to *http://localhost*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**authLogin**](AuthApi.md#authlogin) | **POST** /api/v1/auth/login | Login
|
|
[**authLogout**](AuthApi.md#authlogout) | **POST** /api/v1/auth/logout | Logout
|
|
[**authMe**](AuthApi.md#authme) | **GET** /api/v1/auth/me | Me
|
|
[**authRefresh**](AuthApi.md#authrefresh) | **POST** /api/v1/auth/refresh | Refresh
|
|
|
|
|
|
# **authLogin**
|
|
> TokenPair authLogin(loginRequest)
|
|
|
|
Login
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
|
|
final api = FintrackerApi().getAuthApi();
|
|
final LoginRequest loginRequest = ; // LoginRequest |
|
|
|
|
try {
|
|
final response = api.authLogin(loginRequest);
|
|
print(response);
|
|
} on DioException catch (e) {
|
|
print('Exception when calling AuthApi->authLogin: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**loginRequest** | [**LoginRequest**](LoginRequest.md)| |
|
|
|
|
### Return type
|
|
|
|
[**TokenPair**](TokenPair.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json, application/problem+json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **authLogout**
|
|
> authLogout(refreshRequest)
|
|
|
|
Logout
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
|
|
final api = FintrackerApi().getAuthApi();
|
|
final RefreshRequest refreshRequest = ; // RefreshRequest |
|
|
|
|
try {
|
|
api.authLogout(refreshRequest);
|
|
} on DioException catch (e) {
|
|
print('Exception when calling AuthApi->authLogout: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**refreshRequest** | [**RefreshRequest**](RefreshRequest.md)| |
|
|
|
|
### Return type
|
|
|
|
void (empty response body)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/problem+json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **authMe**
|
|
> UserOut authMe()
|
|
|
|
Me
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
|
|
final api = FintrackerApi().getAuthApi();
|
|
|
|
try {
|
|
final response = api.authMe();
|
|
print(response);
|
|
} on DioException catch (e) {
|
|
print('Exception when calling AuthApi->authMe: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**UserOut**](UserOut.md)
|
|
|
|
### Authorization
|
|
|
|
[HTTPBearer](../README.md#HTTPBearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json, application/problem+json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **authRefresh**
|
|
> TokenPair authRefresh(refreshRequest)
|
|
|
|
Refresh
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:fintracker_api/api.dart';
|
|
|
|
final api = FintrackerApi().getAuthApi();
|
|
final RefreshRequest refreshRequest = ; // RefreshRequest |
|
|
|
|
try {
|
|
final response = api.authRefresh(refreshRequest);
|
|
print(response);
|
|
} on DioException catch (e) {
|
|
print('Exception when calling AuthApi->authRefresh: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**refreshRequest** | [**RefreshRequest**](RefreshRequest.md)| |
|
|
|
|
### Return type
|
|
|
|
[**TokenPair**](TokenPair.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json, application/problem+json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|