osm-api 0.1.1

Rust binding for the Open Street Map Api
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

# OpenStreetMap API Rust Binding


A Rust binding for the [OpenStreetMap API](https://wiki.openstreetmap.org/wiki/API#REST_specifications_for_the_editing_API) that allows you to interact with OpenStreetMap data programmatically. This crate aims to provide a simple and efficient way to access and manipulate OSM data in your Rust projects.
**NOTE: This project is still on early stages of development, and many function are not yet implemented. If you interested in contributing, please feel free to do so.**

## Features


- **Rust-friendly API:** Convenient Rust interface for interacting with OSM data.
- **XML Parsing:** Built-in support for parsing and serializing OSM XML data.
- **Extensible:** Designed to be extended with additional API functions and authentication support.

## API Documentation


- **Official OSM API Documentation:**  
  [OpenStreetMap API v0.6](https://wiki.openstreetmap.org/wiki/API_v0.6)

## Installation


Add this crate to your `Cargo.toml`:

```sh
cargo add osm-api
```

## Usage Example


Below is a simple example demonstrating how to fetch and display OSM data:

```rust
extern crate osm_api;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Replace "some_endpoint" with an actual API endpoint.
    let response = osm_api::get_data("some_endpoint")?;
    println!("{:#?}", response);
    Ok(())
}
```

## Current TODO


- [ ] Implement tests
- [ ] Add functions for direct access to the API
- [ ] Integrate OAuth features for authentication
- [ ] Improve overall documentation

## Version Compatibility


| API version | Rust binding version |
|-------------|----------------------|
| 0.6         | 0.1.*                |


## Contributing


Contributions are welcome! If you encounter issues or have ideas for improvements, please open an issue or submit a pull request.

## License


This project is licensed under the [MIT License](LICENSE-MIT) OR [APACHE-2.0 License](LICENSE-APACHE).