osrm_dart_sdk

Open Source Routing Machine API

This Dart package is automatically generated by the OpenAPI Generator project:

• API version: 1
• 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:
  osrm_dart_sdk:
    git: https://github.com/wbt-solutions/osrm_dart_sdk.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  osrm_dart_sdk:
    path: /path/to/osrm_dart_sdk

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:osrm_dart_sdk/api.dart';


final api_instance = OSRMApi();
final version = version_example; // String | Version of the protocol implemented by the service. v1 for all OSRM 5.x installations
final profile = profile_example; // String | Mode of transportation, is determined statically by the Lua profile that is used to prepare the data using osrm-extract. Typically car, bike or foot if using one of the supplied profiles.
final coordinate = coordinate_example; // String | 
final number = 56; // int | Number of nearest segments that should be returned.
final bearings = bearings_example; // String | Limits the search to segments with given bearing in degrees towards true north in clockwise direction.
final radiuses = radiuses_example; // String | Limits the search to given radius in meters.
final generateHints = true; // bool | Adds a Hint to the response which can be used in subsequent requests, see hints parameter.
final hints = hints_example; // String | Hint from previous request to derive position in street network.
final approaches = approaches_example; // String | Keep waypoints on curb side.
final exclude = exclude_example; // String | Additive list of classes to avoid, order does not matter.

try {
    final result = api_instance.nearest(version, profile, coordinate, number, bearings, radiuses, generateHints, hints, approaches, exclude);
    print(result);
} catch (e) {
    print('Exception when calling OSRMApi->nearest: $e\n');
}

Documentation for API Endpoints

All URIs are relative to https://router.project-osrm.org

Class	Method	HTTP request	Description
OSRMApi	nearest	GET /nearest/{version}/{profile}/{coordinate}.json
OSRMApi	route	GET /route/{version}/{profile}/{coordinates}
OSRMApi	table	GET /table/{version}/{profile}/{coordinates}
OSRMApi	trip	GET /trip/{version}/{profile}/{coordinates}

Documentation For Models

• Annotation
• AnnotationMetadata
• ApiResponse
• Intersection
• Lane
• NearestResponse
• NearestResponseAllOf
• NearestWaypoint
• NearestWaypointAllOf
• Route
• RouteLeg
• RouteResponse
• RouteResponseAllOf
• RouteStep
• StepManeuver
• TableResponse
• TableResponseAllOf
• TripResponse
• TripResponseAllOf
• TripWaypoint
• TripWaypointAllOf
• Waypoint

Documentation For Authorization

All endpoints do not require authorization.

Author