ajeek_client 0.1.0-SNAPSHOT
ajeek_client: ^0.1.0-SNAPSHOT copied to clipboard
Ajeek dart client library of Rest api
ajeek_client #
Ajeek api document
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: 0.1.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.DartClientCodegen
Requirements #
Dart 2.12 or later
Installation & Usage #
Github #
If this Dart package is published to Github, add the following dependency to your pubspec.yaml
dependencies:
ajeek_client:
git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
Local #
To use the package in your local drive, add the following dependency to your pubspec.yaml
dependencies:
ajeek_client:
path: /path/to/ajeek_client
Tests #
TODO
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:ajeek_client/api.dart';
// TODO Configure HTTP Bearer authorization: bearerAuth
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken(yourTokenGeneratorFunction);
final api_instance = ApplianceResourcesApi();
final id = 789; // int |
try {
final result = api_instance.callGet(id);
print(result);
} catch (e) {
print('Exception when calling ApplianceResourcesApi->callGet: $e\n');
}
Documentation for API Endpoints #
All URIs are relative to http://localhost:12600
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ApplianceResourcesApi | callGet | GET /appliance/{id} | Get an appliance |
| ApplianceResourcesApi | create | POST /appliance/ | User add appliance |
| ApplianceResourcesApi | list | GET /appliance/list | Get user' all appliances |
| BaseResourcesApi | getBands | GET /base/brands | Get all brands and models |
| BaseResourcesApi | getPreSignedUploadUrl | GET /base/preSignedUploadUrl | |
| RootIndexApi | test | GET /test | Index test |
| RootIndexApi | testIndex | GET /index | Index test |
| RootIndexApi | testUser | GET /user/test | User authentication test |
| SynchroTeamCallbackApi | callback | POST /callback/synchroteam | SynchroTeam callback |
Documentation For Models #
- Appliance
- ApplianceRequestDTO
- ApplianceResponseDTO
- Brand
- GrantedAuthority
- Model
- ResBaseApplianceResponseDTO
- ResBaseListAppliance
- ResBaseListBrand
- ResBaseString
- User
Documentation For Authorization #
Authentication schemes defined for the API:
bearerAuth #
- Type: HTTP Bearer authentication