Feature Request: API

[pvieira84]

Discussed in #88

^{Originally posted by pvieira84 August 30, 2024}
Any chance an API can be added to the roadmap? I believe it would be helpful and handy for a large group of people

[Egglestron]

The only thing that would convince me to abandon Tricount!

[idoodler]

Would be awesome to integrate it with iOS Shortcuts

[krokosik]

We could use this maybe? https://github.com/mcampa/trpc-to-openapi

[krokosik]

@pvieira84 @idoodler @Egglestron I am working on an integration right now, which would enable a RESTful API together with a new OpenAPI json endpoint and a SwaggerUI page. Once that is done, would you be willing to help with writing description for the existing endpoints?

[krokosik]

I would like to further discuss what you would expect from a REST API. Does it have to cover ALL the endpoints or will a subset be enough? I am also not sure how credentials could be handled within NextAuth. I assume something like API keys would be preferred, but I don't see this functionality in the library.

The trpc-to-openapi would require extensive refactoring and testing, since it requires full input and output validation, which was sadly not implemented by the original author and it breaks some routes.