Rust API client for geoprox-client

Geoprox server implementation providing a HTTP API for geospatial queries and position tracking

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

API version: 0.3.1
Package version: 0.3.1
Build date: 2024-08-06T02:23:57.237469474-04:00[America/New_York]
Generator version: 7.7.0
Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named geoprox-client and add the following to Cargo.toml under [dependencies]:

geoprox-client = { path = "./geoprox-client" }

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
GeohashApiApi	decode_geohash	GET /api/v1/geohash/{ghash}	Decode geohash into coordinates.
GeohashApiApi	encode_latlng	GET /api/v1/geohash	Encode coordinates into geohash
GeohashApiApi	get_neighbors	GET /api/v1/geohash/{ghash}/neighbors	Neighboring regions
GeoshardApiApi	create_index	POST /api/v1/shard/{index}	Create geospatial index
GeoshardApiApi	drop_index	DELETE /api/v1/shard/{index}	Drop index
GeoshardApiApi	insert_key	PUT /api/v1/shard/{index}	Insert key into index
GeoshardApiApi	query_range	GET /api/v1/shard/{index}	Search nearby
GeoshardApiApi	remove_key	PATCH /api/v1/shard/{index}	Remove key from index

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author