Unofficial Lemmy OpenAPI Documentation (mv-gh.github.io)

submitted 1 year ago by testAccount@programming.dev to c/lemmy_dev@programming.dev

4 comments fedilink hide all child comments

Hey folks, I created a OpenApi documentation of the Lemmy API.

https://mv-gh.github.io/lemmy_openapi_spec/

all 5 comments

sorted by: hot top controversial new old

[-] freamon@endlesstalk.org 3 points 1 year ago

This is easier to navigate than the official one. I don't know why they're so stubborn about only generating it from the JS client.

It could maybe benefit from some examples though. On both docs, looking at resolve_object for example, it says I need to provide a value for 'q'. The first time I saw that, I thought: What the hell is q? (like much of the API, it's actually easier than I was assuming, in that it's just the full absolute link to a post or a community etc, but I could have done with a hint)

[-] testAccount@programming.dev 5 points 1 year ago

Their approach requires no additional work as it's fully automated. That's the biggest reason.

I wrote the routes manually which took some time. And it still needs quite some work for the summaries and descriptions

[-] freamon@endlesstalk.org 1 points 1 year ago

I wrote the routes manually which took some time

I bet. My own efforts never got very far at all. Sorry if I seemed negative, I was mostly just having a moan about some of their terminology choices. I didn't know you'd still be working on it, but it's great that you are.

Meanwhile, just for fun, have you seen KBIN's docs? It's all this really nice-looking stuff, all for a URL that ... doesn't resolve.

[-] testAccount@programming.dev 2 points 1 year ago* (last edited 1 year ago)

Yeah KBIN is getting the fundamentals right and at a pretty fast pace. I just don't like their nomenclature and techstack. It's also trying to be twitter and reddit at the same time.

Lemmy actually uses it own API, so you would think they would have documentation as a priority. Lemmy gets funded by NLnet (so is KBIN) and they get paid by each released feature. I think they focused too much on adding features, and this feature creep caused big performance issues. Aggregation is still big performance hog that causes instability which probably the biggest problem rn with Lemmy. They also wasted lots of resources into things that don't scale like the AsyncApi. Before they got hit by the reddit migration, they were even thinking of doing 1.0.0 release, that woulda complicated a lot of things. It's good that the migration happened, it shook Lemmy devs, probably would have been better if it happened earlier though.

this post was submitted on 14 Aug 2023

36 points (100.0% liked)

Lemmy Bots and Tools

455 readers

1 users here now

Welcome to the programming.dev lemmy development community! This is a place to discuss and show off bots, tools, front ends, etc. you're making that relate to lemmy

Theres another version of this community over at lemm.ee if you want to subscribe to that one as well

Icon base by DarkZaitzev under CC BY 3.0 with modifications to add a gradient

founded 1 year ago

MODERATORS

Ategon@programming.dev

bugsmith@programming.dev