Oq: Terminal OpenAPI Spec Viewer

by der_gopheron 9/12/2025, 2:53 PMwith 20 comments

by RadiozRadiozon 9/12/2025, 6:08 PM

Nice, I'll find this useful. I reference OpenAPI specs frequently as I practice spec-driven development. The spec is my source of truth for the interface, and I use it to generate both my client and server code. It automates all the request handling boilerplate on both sides, including validation, and provides me a typed interface regardless of which language I'm using. OpenAPI of course limits the types of endpoints you can create, but I find those limits stop you doing things that are strange/surprising. I find that creating APIs that can be expressed nicely in OpenAPI leads to APIs that have a consistent feel with few gotchas and a satisfyingly predictable developer experience.

by barryoneillon 9/12/2025, 7:09 PM

Nice! Just a quick heads up that there's already an 'oq' project

https://blacksmoke16.github.io/oq/ | https://github.com/Blacksmoke16/oq

(as I discovered when I installed oq via homebrew to find myself with a different app)

by jamietannaon 9/12/2025, 6:52 PM

Ooh interesting!

I see it notes OpenAPI 3.1 support, but it's using kin-openapi which doesn't yet support OpenAPI - how have you managed that?

(speaking as someone building on top of kin-openapi, as a core maintainer for oapi-codegen)

by patrickhogan1on 9/13/2025, 1:20 AM

Looks great. Is it a terminal-based viewer for API specs (like Swagger UI) or a tool for defining APIs that OpenAI can call?

by dot1xon 9/16/2025, 12:15 PM

Where's the search? Can't seem to search in any way.

by oulipo2on 9/12/2025, 5:29 PM

Really cool! would be cool to be able to do the actual call too :)

by neiescon 9/13/2025, 5:18 PM

Awesome

by rtk0on 9/12/2025, 5:15 PM

Love this.