Aare.guru API Dart Wrapper

Unofficial wrapper of the Aare.guru API for the Dart language. Aare.guru provides infos about bathing spots in the Aare river in Switzerland.

This package provides a type-safe way to interact with the Aare.guru API. It is written in Dart and can be used in any Dart project.

Aare.guru?

Look here: Aare.guru
API documentation: Aare.guru API

Getting started

Import the package in your dart project.

Add the following to your pubspec.yaml:

dependencies:
  aareguru_api:
    git: https://github.com/Wii42/aareguru_api_dart_wrapper

Then run dart pub get to install the package, or flutter pub get if you are using Flutter.

Usage

Now in your Dart code, you can use:

import 'package:aareguru_api/aareguru_api.dart';

For examples see the example.

Note

This package is still in development and may not be stable. Breaking changes may occur in every future version until the first stable release.

See the CHANGELOG for details about the changes in each version.

Some fields have been renamed in comparison to the API to better clarify their meaning and conform to camelCase. For example, 'aare' in Today is now 'aareTemperature' and 'longname' in City is now 'longName'. If a field has been renamed, is specified in the documentation for the field. For example Original API field name: <code>text_short</code>. If nothing is specified, the field name is the same as in the API.

License

This package is licensed under the GNU GPLv3. See the LICENSE file for details.