[Feature] RESTful API + OpenAPI 3.0 specifications + language support

[Maxiimeeb]

Verified feature request does not already exist?

• I have searched and found no existing issue (I didn't know the feature request were automatically closed. I find a similar request later, but missing the OpenAPI 3.0 specifications + language support [Feature] Implement RESTful API so that I can integrate with Home Automation or other home server tools  #1384)

💻

• Would you like to implement this feature?

Pitch: what problem are you trying to solve?

I want to use the actual API, but it's only available in JavaScript. From what I see, it would be tedious to make this API available in other languages. I want to make this process easier.

Describe your ideal solution to this problem

In the actual-server project, it would be nice to add routes for a RESTful API with OpenAPI 3.0 specifications. With a RESTful API and good specifications, we could use a code generator that takes in OpenAPI 3.0 and outputs a client for use (e.g., https://swagger.io/tools/swagger-codegen/). It would simplify the support for other languages.

Teaching and learning

We can now interact with Actual in any other languages easily

[github-actions]

✨ Thanks for sharing your idea! ✨

This repository uses lodash style issue management for enhancements. That means enhancement issues are automatically closed. This doesn’t mean we don’t accept feature requests, though! We will consider implementing ones that receive many upvotes, and we welcome contributions for any feature requests marked as needing votes (just post a comment first so we can help you make a successful contribution).

The enhancement backlog can be found here: https://github.com/actualbudget/actual/issues?q=label%3A%22needs+votes%22+sort%3Areactions-%2B1-desc+

Don’t forget to upvote the top comment with 👍!

[twk3]

@Maxiimeeb I see that you saw the other issue, but did you also take a look at https://github.com/jhonderson/actual-http-api ?

I wonder if contributing changes there to bring it to align it with openAPI 3 would be better.

For the actual-server, it shouldn't be making changes to the data, as that component is intended as a data storage service primarily, and not a typically backend, but you can optionally have a rest api running a client and api alongside it.

[youngcw]

Closing in favor of #1384. Make some comments there to add more details about openAPI 3 and maybe other languages.