HN Explorer

Show HN: Zudoku – Open-Source Documentation Framework for APIs (github.com)

14 points by martyndavies ↗ HN
Hey all! At Zuplo, we couldn’t find an open-source documentation solution that met our high standards for both trustworthiness and programmability, so we decided to create our own (you know, as you do).

Zudoku is a framework for building high quality, interactive API documentation. We’ve now released it as an OSS project under a MIT license: https://github.com/zuplo/zudoku)

It’s predominantly built around a highly interactive API reference powered by OpenAPI (with GraphQL support on the way), but also has MDX support, authentication options such as Auth0 and Clerk, search, static site generation, theming, and a plugin architecture that we hope will enable developers to extend Zudoku however they want/need for their use cases. All the details, and all the docs are at http://zudoku.dev

Also, if you'd like to see what your API reference would like using Zudoku, you can do that by entering a URL for an OpenAPI document or uploading the file over at https://zudoku.dev

This release is the beta version and we’d love feedback on it, either here or on GitHub.

We’re going to continue to work on it ourselves, and put out regular releases, but if anyone else wants to get involved, please play with it and let us know where you see areas for improvement.

5 comments

[ 3.6 ms ] story [ 14.5 ms ] thread
[deleted]
(comment deleted)
DataOverload
Awesome project - how does this compare to other API docs tools out there?
nathantotten
Thanks for checking it out. The focus of Zudoku is on making it super easy to ship beautiful API documentation. There are tons of alternatives, but we didnt feel like anything out there met our bar in terms of design and ease of use.

Zudoku is also the basis of part of our product (zuplo.com) offering so it is extremely extensible. Our managed, hosted version builds on the extensibility of Zudoku to add additional capabilities like API Key management, analytics, etc. Anyone can use these extensibility points to add their own custom capabilities.

mosch
Thanks! I'm Mo, one of the authors of Zudoku. Zudoku is a tool for creating highly interactive API docs that can grow into a fully-fledged developer portal with everything you need (usage, debugging tools, API keys).

You can do this by extending Zudoku with plugins that you can share within the community. So we can build this thing together (The docs are not quite done yet for plugins https://zudoku.dev/docs/custom-plugins)

Also, it's free & open source!

Do you think that's different from other tools?