Insomnia: [Feature Request] Export as OpenAPI

Created on 13 Nov 2019  路  14Comments  路  Source: Kong/insomnia

Would like to be able to export as OpenAPI. Pretty simple. Thanks.

accepted good first issue help wanted

Most helpful comment

really need this feature

All 14 comments

馃憢 Thanks for opening your first issue! If you're reporting a 馃悶 bug, please make sure
you include steps to reproduce it. If you're requesting a feature 馃巵, please provide real
use cases that would benefit. 馃應

To help make this a smooth process, please be sure you have first read the
contributing guidelines.

It would be great! please consider it, thumbs up!

This would be awesome, I agree!

really need this feature

Yeah this would be epic

This would be incredibly useful.

You can actually do it your own in a fairly easy way (especially if you rely on a CI), whenever you sync your API to a remote Git, it creates a .insomnia folder, where inside it automatically creates an ApiSpec folder, inside there's one .yaml file for each one of your API specs.
The good news is: each .yaml is elaborated in such a consistent way that if you exclude the first 3 lines and the last 5 lines of every .yaml file inside .insomnia/ApiSpec/, you'll obtain an OpenAPI compatible file.

I think a simple JS editor can be done meanwhile, but I rather see that implemented as an actual feature...

That will be awesome while swaggymniav is a decent solution currently.

That will be awesome while swaggymniav is a decent solution currently.

I tried swaggymnia but it is not working with Insomnia v4 and the latest insomnia is only allowing to export in Insomnia v4. Any idea how to proceed?

The good news is: each .yaml is elaborated in such a consistent way that if you exclude the first 3 lines and the last 5 lines of every .yaml file inside .insomnia/ApiSpec/, you'll obtain an OpenAPI compatible file.

While Insomnia currently doesn't _generate_ an OpenAPI spec (and I agree it would be a useful feature), just chiming in that we've recently released inso, a companion CLI through which you can export the spec written in designer into a file (as an alternative to the comment quoted). 馃槃

inso export spec specName -o output.yaml

I've created a very basic npm package here which may suit the needs. Can someone give it a try. Its an early release and thus not a cli usable package, but it does borrow some of the items from swaggymnia

https://www.npmjs.com/package/insomnia-openapi-converter/

The fragmentation on this project is a bit worrying and confusing.

With that out of the way, I'm making it clear: I'd love to have this included itself on the Insomnia Core application. Other than the (currently unusable) npm package mentioned above, has there been any progress on this?

Hi @NickAcPT - there was some confusion with the comments/questions and the original feature request here, so I cleared that in my comment above. However, the original feature request currently does not have an progress.

I believe there are enough plugin APIs available in order to create a plugin for Insomnia Core to be able to achieve this.

Was this page helpful?
0 / 5 - 0 ratings