openapi-mock VS oapi-codegen

Since the OpenAPI can effectively describe our resources, we can reuse it to generate a dummy server that can be later used for development and testing purposes without bootstrapping any actual services. There some tools available that can help us with this task, such as Prism, OpenAPI Mock, OpenAPI Backend and the MSW library we have already seen.

I really want the ergonomics of schema-first development from gRPC, combined with the ubiquity of OpenAPI. I couldn't quite find anything I really liked off-the-shelf for node + TypeScript, so I wrote one. It's largely modeled off of https://github.com/oapi-codegen/oapi-codegen for Go.

I've always been excited about OpenAPI and schema-first development, but I'm betting that these artifacts will be extra important in the era of coding agents. Giving the LLM one place to see your entire domain feels like a good way to accelerate the value of these tools. And good for humans, too!

I'm looking for early feedback, suggestions for other projects to look at, moral support, "this is a bad idea" kind of discouragement if necessary, etc.

🔗 GitHub Repository: oapi-codegen

A simple Google search returns https://github.com/oapi-codegen/oapi-codegen

I get wanting to be productive and gravitating towards patterns you’re familiar with but in the end it’s all bloat. http can do routing and patterns and cookies and sessions. database/sql can do your DAL work. uuid (various implementations) work for user/tenant uid+oid obfuscation. JWT libs for auth. You can literally json.unmarshal your config for your whole application or use godotenv to use environment variables. template/html for views. Golang has batteries, it’s just you don’t know what you don’t know so you expect a certain perspective that isn’t how we do things. Like joining a new company, things are different here. If you spent some time to learn the “go way” you’d realize that you don’t need the bloat, you just need the structure. The “where I expect it”.

First, let’s set up our development environment. We’ll use OpenAPI Generator within Docker to generate our HTTP client, keeping our local environment clean. For this demonstration, we’ll work with fakerestapi.azurewebsites.net (kudos to the maintainers of public APIs). Here’s our Docker configuration for the client generator:

> https://github.com/oapi-codegen/oapi-codegen

I'm using it for a small personal project! Works very well. Thank you!

Moving on to oapi-codegen, a tools.go file has been created as exemplified in its repository. I have also created the file internal/handlers/server.go:

To generate the server-side code, we need some library. I found oapi-codegen for that. It supports many popular HTTP libraries (echo, gin, etc.) At the time of writing, I used [email protected]