Importing from Insomnia

[ashitaprasad]

Tell us about the task you want to perform and are unable to do so because the feature is not available
Insomnia is an open source desktop application for API design, debugging and testing. We look forward to supporting API data import from the Insomnia platform. It would include importing requests, allowing users to select the requests that he wants to add to API Dash and let users choose the insomnia environment to be imported.

[ashitaprasad]

Update: The frontend is already implemented.
The only change required will be the addition on Insomnia in ImportFormat enum and adding the parser code.

[kumar-piyush12]

Hi ma'am, I want to contribute to this issue. I am contributing for the first time and I went through CONTRIBUTING.md for guidelines. Please share some approach to solve this problem.

[ashitaprasad]

@kumar-piyush12 You can take a look at other importers currently available in API Dash. Go through the Insomnia format spec and suggest your approach for solving this issue.

[StormGear]

This is marked as a good first issue and high priority. I took it upon myself to do some work on it. This is my approach, similar to already existing importers.

1. Implemented an InsomniaCollection class for defining the structure of the insomnia v4 format spec.
2. In insomnia, the Requests and other details about insomnia workspace are included in the "resources" field of the json exported file.
3. It is worthwhile to note that not all objects in the json are actually requests, hence some logic is written to only use "resources" which are marked "_type":"request"
4. The obtained requests are then mapped to HttpRequestModel Object of the APIDash codebase.
5. The format spec of v4 is not quite consistent, i.e it's json structure may vary, this introduced a few complexities when building the insomnia model.

Here I show practically, an insomnia v4 json format file being imported into APIDash and working quite well.

insomia_import.zip

I'd like to send in a draft pull request, so you can have it reviewed. Thanks

[ashitaprasad]

@StormGear you can send across a draft PR for review.