Looking forward to your feedback when you use it! Currently we validate with mappings from TypeScript to JSONSchema. OpenAPI is definitely a gold standard, but I think JSONSchema is fairly strong as well.
We're still considering better typing solutions like ZOD or OpenAPI wrappers, but our focus right now is core feature parity as an API tool.
We'll do a better job with written documentation! We forgot that video isn't always a medium that people prefer.
> "We forgot that video isn't always a medium that people prefer."
I've recently encountered this same apparent strong preference for video at work (where I lead a platform team whose deliverables support dozens of other teams) and while I can accept it (and even embraced it as we create howto videos), it remains very strange to me. When engaging with new tech I always want to see code and well-organized prose, but if there's a video I usually can't be bothered -- because the quality and signal-to-noise ratio are so often terrible, and it's got terrible ergonomics for highlighting or sharing key takeaways.
Good reminder that creators often aren't representative of their target demographic, or even well-aligned with their preferences.
For people reading this, just remember that people who prefer videos over prose aren't hanging out in a text-only forum like this. There's some self-selection happening here.
You should not automatically assume that most people prefer text over video!
No, but you can guess that people actually doing work and creating software do. I don't want to watch a fucking video when I can refer to actual documentation and potentially cut and paste some example code somewhere.
I happen to know other folks who also “actually do work” who prefer watching a video explainer. I usually prefer text, but sometimes people document features better in vocal conversation vs writing.
You may try cast.ts. It is similar to zod but the parser has .type property which expose the typescript type of the validator, and .sampleValue property which expose a sample value. So you can access the metadata at runtime, which can be reused by other tools like yours.
> We forgot that video isn't always a medium that people prefer.
Oof, that's a hard one for me. I'm firmly in the "can't possibly learn anything technical" from a video category. Specifications and copious examples for me.
Personally, I think JSONSchema and OpenAPI are table stakes for a product such as this.
I also think an embeddable version which runs in browser would be killer, replacing swagger-ui.
We're still considering better typing solutions like ZOD or OpenAPI wrappers, but our focus right now is core feature parity as an API tool.
We'll do a better job with written documentation! We forgot that video isn't always a medium that people prefer.