search

divviup / divviup-api

Divvi Up Control Plane
https://divviup.org
Mozilla Public License 2.0
3 stars 1 forks source link

`divviup-api` API client and/or documentation #201

Open tgeoghegan opened 1 year ago

tgeoghegan commented 1 year ago

Some of our subscribers want to access divviup-api programmatically. To make this easier, we should distribute a client library for that API. Java- or TypeScript are probably a good choice (especially as such a client already mostly exists in divviup-api/app/src/ApiClient.ts), but we'll have to talk to subscribers to see what meets their needs. Or perhaps it will suffice to provide documentation and API specs and let subscribers generate their own clients.

jbr commented 1 year ago

We also could fairly easily offer a cli that could be shelled out to from ops scripts, and an async rust client.

My hunch is that a high quality cli that does everything the web ui can do would be more useful than any particular language's client

jbr commented 6 months ago

I believe this is done?

tgeoghegan commented 6 months ago

We do have the Rust client, but we may still want to distribute a JavaScript client. This issue really tracks making a decision about what clients to maintain for divviup-api and then how to build and distribute them.