Thank you for commenting about the 404. I'm serving the blog using a [custom package that serves your blog from GitHub hosted mark down](https://github.com/jamierpond/madea-blog-core) which was getting it's debut. There was a bug in caching requests to GitHub.
well - the point is. that we wanted to be standards compliant - and want to use existing technologies without actually reiventing a new standard or a proprietary format. (like some of the other api clients took).
and moreover we had this fundamental idea that documentation and testing should be in a single source of truth to avoid documentation drift (not just the spec drift).
And hence we came up with the idea of using markdown as the baseline and doing everything around it.
Well, no. I mean something I can stick in my actual code to ensure it matches the spec, be it through validation, strongly typed interfaces, unit tests or some other mechanism.
Also, while a nice API document is a godsend (and sadly often missing in practice), a way to generate the consuming side of the API (again via various mechanisms) is also a very useful thing.
Re-reading the page, perhaps I got it wrong and it works the other way around? Voiden uses e.g. OpenAPI files and verifies it's still compliant with them? That would work, although it's a bit of a double effort.. still, useful in many cases.
If you take a peek at the commit history [1], you'll see that the project started only last week with some very vague commit messages. The code is also quite messy and unoptimized. It's a cool project but not exactly industry-level software.
will be tidying/optimising as i use it more.
PRs are welcome! this is totally a tool i made just for me, to solve my problems. hopefully other people like it too.
reply