I was listening to a talk yesterday and heard about tool called TypeSpec: https://typespec.io
The idea is to write your OpenAPI file before you write any code. But OpenAPI can be a little verbose so a tool like TypeSpec allows you to write in a more compact, human-readable way and then convert it to OpenAPI.
Then you send around your OpenAPI doc for feedback. Once it's approved, you start writing code.
Interesting! I thought the typical workflow is to derive from the actual implementation, but this is much cleaner.
Well, you can certainly write the code first. :smile:
In the talk the guy says the developers get grumpy when they write a bunch of code, submit their OpenAPI doc for review, and then get told to change a bunch of stuff. :smile:
Also, he was saying when you use TypeSpec you might write 500 lines of code that translate into 5000 lines of OpenAPI code (doc). 10x.
True, that makes a lot of sense and I think at the end it is way cleaner.
Shall we draft a subset for Dataverse at some point to test it?
Well, this is related:
Write Dataverse API v2 proposal and share with communityย #11836
Last updated: Jan 09 2026 at 14:18 UTC