oaspy 2025.8.17b1

oaspy is a quick-and-dirty tool to generate an OpenApi 3.x specification from an insomnia V4 collections.

oaspy

oaspy is a quick-and-dirty tool to generate an OpenApi 3.x specification from an insomnia V4/Yaak collections.

Getting Started

For more, see the documentation.

Installation

oaspy is available on PyPI:

pip install oaspy

Usage

To run oaspy, try any of the following:

oaspy --help

Commands

gen

Generate an OpenApi 3.x file from an Insomnia/Yaak collections v4.

oaspy gen --help

• with the default options.

# using Insomnia v4
oaspy gen --file Insomnia_file_v4.json

# using Yaak v4
oaspy gen --file Yaak_file_v4.json

• defining the version of openapi to generate.

# using Insomnia v4
oaspy gen --file Insomnia_file_v4.json --schema v30

# using Yaak v4
oaspy gen --file Yaak_file_v4.json --schema v30

argument v30 refers to openapi version 3.0.x

• defining the version of openapi to generate and the output file name.

# using Insomnia v4
oaspy gen --file Insomnia_file_v4.json --output my_oa3_export.json

# using Yaak v4
oaspy gen --file Yaak_file_v4.json --output my_oa3_export.json

• order folders

# using Insomnia v4
oaspy gen --file Insomnia_file_v4.json -o_f

# using Yaak v4
oaspy gen --file Yaak_file_v4.json -o_f

• order request

# using Insomnia v4
oaspy gen --file Insomnia_file_v4.json -o_r

# using Yaak v4
oaspy gen --file Yaak_file_v4.json -o_r

• a complete version of the above.

# using Insomnia v4
oaspy gen --file Insomnia_file_v4.json --schema v30 --output my_oa3_export.json -o_f -o_r

# using Yaak v4
oaspy gen --file Yaak_file_v4.json --schema v30 --output my_oa3_export.json -o_f -o_r

check

Validates the structure of an OpenApi file.

oaspy check --help

oaspy check --file my_oa3_export.json

info

Shows information from an Insomnia/Yaak v4 file.

oaspy info --help

oaspy info --file Insomnia_file_v4.json

oaspy info --file Yaak_file_v4.json

License

This project is licensed under the terms of the MIT. license.

The full text of this license can be found in the LICENSE. file.

How to Contribute

For any questions, comments, suggestions or contributions, go to the issues. section. Before opening a new issue, check the existing ones to find a solution (possibly already existing) to the problem you are facing.