Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add support for importing requests from OpenAPI 3 JSON/YAML #634

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

akshayw1
Copy link
Contributor

@akshayw1 akshayw1 commented Mar 4, 2025

PR Title:

feat: Add support for importing requests from OpenAPI 3 & Swagger 2 JSON/YAML

PR Description

This is a draft PR. Soon, I will add test cases once you review the implementation.

This PR introduces support for importing requests from OpenAPI 3 and Swagger 2 JSON/YAML files. The developed code:

  • Parses OpenAPI 3 and Swagger 2 specifications from JSON/YAML files
  • Extracts data & examples provided in the specs
  • Allows users to select requests to add to the API Dash collection
  • Generates corresponding request items based on user selection

Additionally, I have added a video demonstrating the feature.

Screen.Recording.2025-03-03.at.8.42.30.PM.mp4

Related Issues

Checklist

  • I have gone through the [[contributing guide](https://github.com/foss42/apidash/blob/main/CONTRIBUTING.md)](https://github.com/foss42/apidash/blob/main/CONTRIBUTING.md)
  • I have updated my branch and synced it with the project main branch before making this PR
  • I am using the latest Flutter stable branch (run flutter upgrade and verify)
  • I have run the tests (flutter test), and will add more test cases after review

Added/Updated Tests?

  • Not yet, will add soon after review
  • Yes (To be added)

OS on which you have developed and tested the feature?

  • Windows
  • macOS
  • Linux

Let me know if any changes are needed! 🚀

- Parse OpenAPI 3  specifications from JSON/YAML files
- Extract data & examples provided in the specs
- Allow users to select requests to add to the API Dash collection
@akshayw1
Copy link
Contributor Author

akshayw1 commented Mar 4, 2025

@ashitaprasad Please review and Let me know for any changes required.

@akshayw1
Copy link
Contributor Author

akshayw1 commented Mar 4, 2025

@ashitaprasad Waiting to get the PR reviewed so that I can proceed with other issues! Please

@akshayw1
Copy link
Contributor Author

akshayw1 commented Mar 7, 2025

@ashitaprasad While you review, could you suggest any next issue related to my proposal that I can work on in the meantime?

@akshayw1
Copy link
Contributor Author

@ashitaprasad Could you provide an update on the PR? I’d like to assess whether the work aligns with our goals before deciding on submitting a proposal.

@akshayw1
Copy link
Contributor Author

@ashitaprasad ?

@DenserMeerkat
Copy link
Contributor

@akshayw1 Have you used any AI tools to generate the code on this PR?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this can be generalized to support all specs instead of being specific to openapi

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As per instruction provided in PR, it was for openapi, I can generalise it for all specs

@akshayw1
Copy link
Contributor Author

@akshayw1 Have you used any AI tools to generate the code on this PR?

Some of code is generated with ai tool in this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Importing Requests from OpenAPI Specification file
3 participants