clarkwinkelmann the best way to learn about the REST API would be to use the browser development tools to inspect the requests made by the Flarum single page app.
I am working with REST APIs for years, but only in bash and python scripts. After opening the dev tools in the browser on this forum, I only could see a lot of errors and warnings. And even after clicking the trash icon in the dev menu and clicked on the forum (e.g. liked a post), nothing happened.
May I asked for a small example with a step by step guide, because I can't figure anything out.
clarkwinkelmann The ideal solution would scan all the popular extensions as well to offer a centralized documentation that takes into account first- and third-party extensions.
Automatic docs creating might sound like a good idea, but I know bad examples, where code had really bad comments and reading some of them in the api doc didn't give the reader any clue on how to use it?
Every post should include an example with dummy data to see which keys are used in a post request. And example response should be provided, too, like it was already done here. But creating dummy data automatically could be a challenging part, because it should be still readable.
I am a little bit afraid that automatic docs creation could be too complicated that people don't even start to implement it and creating the api docs by hand could be much faster.
