appsmith icon indicating copy to clipboard operation
appsmith copied to clipboard

[Feature] Import API definition from swagger file

Open sumitsum opened this issue 4 years ago • 17 comments

Summary

Import/create new API from swagger file

Motivation

Requested by community.

Discord chat:

Basically similar to curl import, to allow importing APIs
a set of APIs* without filling each individual API form
(Since most APIs service have openapi/swagger definition)

sumitsum avatar Apr 08 '21 06:04 sumitsum

any plans about it ?

danysz avatar Dec 28 '21 14:12 danysz

Hi @danysz! We haven't planned this feature. We'll pick it up if we see a little more requests for it but as of now it hasn't ranked very high on our community requests

Nikhil-Nandagopal avatar Dec 28 '21 15:12 Nikhil-Nandagopal

+1 for this feature.

What I'd like to see happening also is to then have validation of field inside the app (e.g. drop-down box auto-filled with enum values, auto-suggestion in a free text field or error indicators when something invalid is entered).

ghost avatar Feb 07 '22 13:02 ghost

+1

svanschooten avatar Feb 28 '22 10:02 svanschooten

Another +1 to this. Building out a custom Datasource from an internally deployed commercial product datasource would be much simpler with support for this.

bberenberg avatar Sep 23 '22 20:09 bberenberg

Another +1. As an Appsmith partner, we really need this feature to introduce Appsmith as a worthy low code tool to our customers. Most of the APIs that need to be integrated have a swagger/OpenAPI contract.

The idea would be to create a query based on an endpoint defined in the Swagger/OpenAPI contract. Based on that, the headers, body, etc. of the request are already filled with data from the contract. As an Appsmith engineer, you only need to map the values to the correct data.

dennisdereyer-sg avatar Feb 08 '23 12:02 dennisdereyer-sg

+1 -- A must have IMHO. It helps on integrating departments. I leave in appsmith the API datasource with all of the endpoints I support and other areas can use them to build their own tools on top. Facilitates the discovery of available actions to end users

osangenis avatar Feb 20 '23 11:02 osangenis

Hey @osangenis @dennisdereyer-sg @bberenberg @enote-kane @danysz @sumitsum We have built a utility that can import a swagger / openapi spec or a postman collection export into Appsmith by defining Datasources and add all the endpoints defined. If you are interested in using it we can continue the conversation.

kaprinsoftware avatar Apr 15 '23 14:04 kaprinsoftware

@kaprinsoftware Hi, we would like to try it out!

dennisdereyer-sg avatar Apr 17 '23 06:04 dennisdereyer-sg

Hey @dennisdereyer-sg , could you please submit this form to share with us details to reach out. We will shortly setup sometime to go through it together. Thanks!

kaprinsoftware avatar Apr 17 '23 12:04 kaprinsoftware

Hey @dennisdereyer-sg it looks like the form link didn't come through the last time. I have updated the comment. Here is the link as well. Looking forward to hear from you and hopefully help you get across the challenge https://forms.gle/ia15HNsCtoYHpScaA

kaprinsoftware avatar Apr 18 '23 18:04 kaprinsoftware

@kaprinsoftware This is Balaji from the Appsmith product team. It's great that you came up with this solution, and we would love to see it in action. Would you be open to doing a demo of this? Please feel free to book on my calendar here.

sribalajig avatar Apr 19 '23 04:04 sribalajig

Hi @sribalajig I have setup the following time. Looking forward to it. 12:30pm - 1:15pm, Monday, April 24, 2023

kaprinsoftware avatar Apr 19 '23 08:04 kaprinsoftware

Hey @dennisdereyer-sg please let me know if you are still interested in connecting regarding this tool.

kaprinsoftware avatar May 29 '23 11:05 kaprinsoftware

Been a year now, any movement here?

akbisw avatar May 03 '24 14:05 akbisw

Would love to see an openapi spec import like Retool has.

jphelpsqred avatar Aug 06 '24 09:08 jphelpsqred

This would be useful..

CLFPosthumus avatar Oct 31 '25 22:10 CLFPosthumus