Unofficial Lemmy OpenAPI Documentation
Unofficial Lemmy OpenAPI Documentation
Hey folks, I created a OpenApi documentation of the Lemmy API.
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.