fin-tracker/app/packages/api_client/doc/HealthApi.md

fintracker_api.api.HealthApi

Load the API package

import 'package:fintracker_api/api.dart';

All URIs are relative to http://localhost

Method	HTTP request	Description
healthCheck	GET /api/v1/health	Check

healthCheck

Health healthCheck()

Check

503 when the database cannot be reached, so a container healthcheck can trust the code.

Example

import 'package:fintracker_api/api.dart';

final api = FintrackerApi().getHealthApi();

try {
    final response = api.healthCheck();
    print(response);
} on DioException catch (e) {
    print('Exception when calling HealthApi->healthCheck: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

Health

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]