Importing Requests from OpenAPI Specification file

[ashitaprasad]

Tell us about the task you want to perform and are unable to do so because the feature is not available
Add support for importing requests from the json or yaml files in OpenAPI 3 and Swagger 2 data formats. The developed code should be able to parse the data & examples provided in the specs, let user choose the requests he wants to add to the API Dash collection and create the corresponding request items.

[ashitaprasad]

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

[sajid-31]

OPENAPI specification document contains multiple endpoints and these endpoints branched into folders based on tags and into sub-folders based on /paths
The POSTMAN implementation creates a separate collection on importing openapi file and maintains branching based on tags and endpoints.
But I'm not sure if APIDASH has nested collections.
Rightnow, I'm implementing the parser using DART:CONVERT package.
The basic implementation will add all the endpoints by parsing them into HttpRequestModel
Can I proceed with this approach?

[ashitaprasad]

@sajid-31 You can use this package to parse the OpenAPI spec file - https://pub.dev/packages/openapi_spec
Since OpenAPI spec is usually a dump of all the endpoints, once you have the parsed results, you should focus on allowing user to select the endpoints they want to include and add request models to the collections for the selected endpoints.

[sajid-31]

There is no documentation for openapi_spec. I'm not sure how to implement using this package.
Can you provide a resource which might help me understand this package.
Or should I look for alternatives?

[ashitaprasad]

https://pub.dev/documentation/openapi_spec/latest/openapi_spec/

[sajid-31]

Query parameters can be added directly to the request model for each request endpoint.
How should path parameters be handled?
Since these can be accessed through environment variables, is it better to create a new environment for an OPENAPI JSON/YAML file upload and add the path parameters as variables, or should they be added to the global variables?

[ashitaprasad]

@sajid-31 There is no need to create a new environment. You can add path parameters enclosed as{{param}} in the URL itself. It will get highlighted in red and user can create the requisite environment variable or replace it with a hardcoded string as per personal preference.