Unofficial Lemmy OpenAPI Documentation
Unofficial Lemmy OpenAPI Documentation
Hey folks, I created a OpenApi documentation of the Lemmy API.
You're viewing a single thread.
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)
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
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.
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.