Skip to content

Commit

Permalink
WebSocket client module
Browse files Browse the repository at this point in the history
The KittyCAD Rust API client lets users connect to our WebSocket API. But OpenAPI can't tell users what the server expects to receive over that WebSocket, or what it intends to send over the WebSocket either.

This library solves the problem. It encapsulates the WebSocket connection from our API client, and adds methods to send and receive the correct types. This way users will always send the right types of requests and always receive the right types of responses.

Right now, this API sends over WebSocket text messages (JSON) to make it easier to debug with standard web debugging tools. But in the future, we can offer WebSocket binary messages (BSON), for faster de/encoding.
  • Loading branch information
adamchalmers committed Dec 13, 2023
1 parent eb01834 commit 76e158b
Show file tree
Hide file tree
Showing 6 changed files with 1,438 additions and 55 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,5 @@ jobs:
uses: actions/checkout@v4
- name: Check semver
uses: obi1kenobi/cargo-semver-checks-action@v2
with:
package: kittycad-modeling-cmds
Loading

0 comments on commit 76e158b

Please sign in to comment.