github-starred/actual
2
0
Fork 0
mirror of https://github.com/actualbudget/actual.git synced 2026-03-22 00:13:45 -05:00
Code Issues 250 Packages Projects Releases 53 Wiki Activity

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

New Issue
Closed
opened 2026-02-28 19:20:36 -06:00 by GiteaMirror · 3 comments
GiteaMirror commented 2026-02-28 19:20:36 -06:00
Owner
Copy Link

Originally created by @Maxiimeeb on GitHub (Dec 9, 2023).

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 https://github.com/actualbudget/actual/issues/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

Originally created by @Maxiimeeb on GitHub (Dec 9, 2023). ### Verified feature request does not already exist? - [X] 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 https://github.com/actualbudget/actual/issues/1384) ### 💻 - [X] 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
GiteaMirror added the feature label 2026-02-28 19:20:36 -06:00
GiteaMirror commented 2026-02-28 19:20:37 -06:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Dec 9, 2023):

✨ 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 👍!

@github-actions[bot] commented on GitHub (Dec 9, 2023): :sparkles: Thanks for sharing your idea! :sparkles: 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 👍! <!-- feature-auto-close-comment -->
GiteaMirror commented 2026-02-28 19:20:37 -06:00
Author
Owner
Copy Link

@twk3 commented on GitHub (Dec 10, 2023):

@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.

@twk3 commented on GitHub (Dec 10, 2023): @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.
GiteaMirror commented 2026-02-28 19:20:37 -06:00
Author
Owner
Copy Link

@youngcw commented on GitHub (Feb 8, 2024):

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

@youngcw commented on GitHub (Feb 8, 2024): Closing in favor of #1384. Make some comments there to add more details about openAPI 3 and maybe other languages.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
AI generated
API
bank sync
budgeting
bug
can’t replicate
dependencies
docker
documentation
electron
experimental feature
feature
feedback
goal templates
good first issue
help wanted
importers
maintenance
needs info
needs testing
needs triage
needs votes
openid
payees
pull-request
Mirrored from GitHub Pull Request
 regression
reports
responsive
rules
schedules
server
✨ merged
split transactions
tech debt
theme
transaction import
transaction reconciliation
transactions
translations
upstream
user interface
✅ approved
wontfix
No Label feature
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#807
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?