How do I generate a dart client for custom nextcloud app?

[samolego]

Are there any guides on this? I'd like to generate a dart client from an existing nextcloud app - is that possible?

[provokateurin]

Hi, this is only possible if you have an OpenAPI specification for it. Which app are you trying to use?

[samolego]

Ah, ok. This one: https://memories.gallery/

[provokateurin]

It doesn't look like it has one available, but you could generated one using https://github.com/nextcloud/openapi-extractor. It requires some work in the app though, as you need to add annotations for every endpoint.

Alternatively you could write an OpenAPI specification by hand, but we will not add it to the official package due to quality and maintainability concerns.

What is your use-case for a memories API client?

[samolego]

I'd like to try create a native flutter app, as the default memories one is a bit slow on mobile devices.

Thanks for the info :)

[provokateurin]

We also have plans to implement a Photos app that can also work with Memories as a backend (#355), so you might want to consider using our framework for building your app.
For a prototype it would be fine to use a hand-written specification, see the discussion in #944 for reference.

[samolego]

Ok, thanks!

[samolego]

Sorry to bother again, I've generated a openapi.yaml from observing the traffic.
Do I have to use dynamite package now?

[provokateurin]

Yes! You should drop the file into packages/nextcloud/lib/src/api and name it memories.openapi.yaml. Then you can run the generate script using ./tool/generate-nextcloud.sh (from the root of the project). Afterwards you should have 3 new dart files.

What tool did you use to generated the specification? I wasn't aware something like that exists.

[samolego]

Well, I navigated around the app, used firefox's save traffic to har file, then used https://github.com/jonluca/har-to-openapi to convert har to openapi.yml.

Not sure if it's correct, first time doing it.