actualbudget / actual-server

Actual's server
https://actualbudget.org
MIT License
3.09k stars 588 forks source link

[Feature request]: OpenAPI or gRPC spec or different machine readable API docs #419

Open endigma opened 1 month ago

endigma commented 1 month ago

Verified issue does not already exist?

What happened?

I'm working on an API integration for ActualBudget replacing part of the actual-server with my own code, but I'm worried about keeping up to date with the client. Have you considered adding a versioned spec layer in-between the client and server? It would be helpful to be able to generate stubs on both sides for building on Actual.

What error did you receive?

No response

Where are you hosting Actual?

None

What browsers are you seeing the problem on?

No response

Operating System

None

tcrasset commented 4 weeks ago

I'm not a maintainer, but I've tried to see what could be done. This is an express app, and there is express-openapi that could help creating these docs, but I think a lot of the steps are manual e.g. for each route, one needs to create the doc, it doesn't seem (AFAIK) to be autogenerated.

It seems this has already been attempted (possibly on a previous version of the server), here: https://github.com/actualbudget/actual-server/pull/62