8 releases (4 breaking)
| 0.5.0 | Aug 23, 2024 |
|---|---|
| 0.4.2 | Aug 12, 2024 |
| 0.3.1 | Aug 6, 2024 |
| 0.2.0 | Aug 3, 2024 |
| 0.1.0 | Aug 3, 2024 |
#491 in HTTP client
442 downloads per month
55KB
888 lines
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.5.0
- Package version: 0.5.0
- Build date: 2024-08-23T17:04:10.114820936-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} | Deletes geospatial index |
| GeoshardApiApi | insert_key | PUT /api/v1/shard/{index} | Insert key into index |
| GeoshardApiApi | insert_key_batch | PUT /api/v1/shard/{index}/batch | Insert multiple keys into index |
| GeoshardApiApi | query_range | GET /api/v1/shard/{index} | Search index for objects nearby |
| GeoshardApiApi | query_range_many | GET /api/v1/shard | Search multiple indices for objects nearby |
| GeoshardApiApi | remove_key | PATCH /api/v1/shard/{index} | Remove key from index |
| GeoshardApiApi | remove_key_batch | PATCH /api/v1/shard/{index}/batch | Remove multiple keys from index |
Documentation For Models
- CreateIndexResponse
- DecodeGeohashResponse
- DropIndexResponse
- EncodeLatLng
- EncodeLatLngResponse
- GeohashNeighborsResponse
- InsertKey
- InsertKeyBatch
- InsertKeyBatchResponse
- InsertKeyResponse
- Neighbor
- QueryRange
- QueryRangeMany
- QueryRangeManyResponse
- QueryRangeResponse
- RemoveKey
- RemoveKeyBatch
- RemoveKeyBatchResponse
- RemoveKeyResponse
To get access to the crate's generated documentation, use:
cargo doc --open
Author
Dependencies
~8–20MB
~274K SLoC