xplane-web-api 0.1.0

Bindings to the X-Plane Web APIs (REST and websocket)
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

# X-Plane Web APIs

Typed Rust access to the documented X-Plane local web APIs.

## Contents

- REST client generated at build time from `openapi/xplane-web-api-v3.yaml` using Progenitor.
- Shared REST error classification (`xplane_web_api::error::RestClientError`).
- Optional `xplane-web-api` CLI for REST operations.
- Optional typed WebSocket request/response models and an async convenience client.

## Features

- Default features: none (REST only).
- `cli`: enables the `xplane-web-api` command-line tool.
- `websocket`: enables typed websocket models + async websocket client.

Run the CLI:

```bash
cargo run -p xplane-web-api --features cli --bin xplane-web-api -- --help
```

CLI logging uses `env_logger`; control verbosity with `RUST_LOG`:

```bash
RUST_LOG=debug cargo run -p xplane-web-api --features cli --bin xplane-web-api -- --help
```

Enable websocket support as a library dependency:

```bash
cargo add xplane-web-api --features websocket
```

## Source docs

The API model in this crate is based on:

- <https://developer.x-plane.com/article/x-plane-web-api/>