15
 Followers
108
 Likes

Consume REST services: Update API methods

Integration
Implemented
on 25 May 2021
Development Environment Release 117

Currently if you have two OutSystems applications, one that exposes a REST API method and the other that consumes the method, in the consumer application you can't see if the method was changed in the exposing application and refresh it.


It would be a good idea to have a "refresh REST API" option that refreshes all the consumed methods from a REST API, like we have for SOAP services (see attached image). Also, to have a warning message in a consuming application that "method x" was changed and you need to refresh that method.


For example, you have a method without input parameters that returns a list of records and you consume it in another application. If in the exposing application you add a mandatory input parameter to the method and then run the consuming application you will get an error message because your request to the service is incorrect.


When you open the consuming application in Service Studio you don't get a warning that one of the consumed methods  has changed and you don't have an easy way to update that method. You have to remove it and then consume it again and for this you need to know what was changed in the method.

 Updateservices.png
Created on 29 Mar 2016
Comments (32)
+1 from me. See also this discussion.

+1

Definitely worth a +1

This would be very helpful.


+1!

Yes, still very much needed. especially suitable for services between apps

+100

Very helpful indeed

+1

+1

+1

+1

+1

Merged this idea with 'Option on the Right-click for Refresh REST API' (created on 14 Jan 2019 11:32:40 by Jardel Araújo)

Right-click on a method and refresh the information and thus structures.



This comment was:
- originally posted on idea 'Option on the Right-click for Refresh REST API' (created on 14 Jan 2019 by Jardel Araújo)
- merged to idea 'Consume REST services: Update API methods' on 09 May 2019 13:25:44 by Fernando Moitinho

Changed the category to Integration




This comment was:
- originally posted on idea 'Option on the Right-click for Refresh REST API' (created on 14 Jan 2019 by Jardel Araújo)
- merged to idea 'Consume REST services: Update API methods' on 09 May 2019 13:25:44 by Fernando Moitinho
Merged this idea with 'Refresh REST API Methods' (created on 03 Mar 2018 18:02:18 by brrrr)

- Say, there are two REST API methods  exposed from an Outsyestems server (X) that is consumed from another Outsyestems server (Y)

- If we add another method in X than we can refresh in Y such that the third method is also shown in the IDE that consumes the X 



This comment was:
- originally posted on idea 'Refresh REST API Methods' (created on 03 Mar 2018 by brrrr)
- merged to idea 'Consume REST services: Update API methods' on 09 May 2019 13:26:09 by Fernando Moitinho

If you are having it generate Swagger documentation you should be able to do this.

J.Ja



This comment was:
- originally posted on idea 'Refresh REST API Methods' (created on 03 Mar 2018 by brrrr)
- merged to idea 'Consume REST services: Update API methods' on 09 May 2019 13:26:09 by Fernando Moitinho


I  would like the ability to right-click on a method and refresh the information and thus structures, so agree!




This comment was:
- originally posted on idea 'Refresh REST API Methods' (created on 03 Mar 2018 by brrrr)
- merged to idea 'Consume REST services: Update API methods' on 09 May 2019 13:26:09 by Fernando Moitinho

hi Justin,

OUtsystems REST API is based on Swagger, however i still need to delete the REST and then get it back to reflect the changes made.

regards,

Tan



This comment was:
- originally posted on idea 'Refresh REST API Methods' (created on 03 Mar 2018 by brrrr)
- merged to idea 'Consume REST services: Update API methods' on 09 May 2019 13:26:09 by Fernando Moitinho

I see... yeah, it needs to be like SOAP, a right-click to refresh...

J.Ja



This comment was:
- originally posted on idea 'Refresh REST API Methods' (created on 03 Mar 2018 by brrrr)
- merged to idea 'Consume REST services: Update API methods' on 09 May 2019 13:26:09 by Fernando Moitinho

A must have for when the API consumed is still in development and being bounced back and forth between teams.



This comment was:
- originally posted on idea 'Refresh REST API Methods' (created on 03 Mar 2018 by brrrr)
- merged to idea 'Consume REST services: Update API methods' on 09 May 2019 13:26:09 by Fernando Moitinho

Must be like SOAP indeed.

Regards,

Paul



This comment was:
- originally posted on idea 'Refresh REST API Methods' (created on 03 Mar 2018 by brrrr)
- merged to idea 'Consume REST services: Update API methods' on 09 May 2019 13:26:09 by Fernando Moitinho

Would be a good improvement.


Merged this idea with 'Refresh REST Service Swagger definition of previous consumed version' (created on 21 Jul 2020 06:49:33 by Daniël Kuhlmann)

It would be nice if a REST Service swagger definition could be refresh, and that the methods and parameters of existing implementation would automatically be updated.

For SOAP service WSDL is this already possible.



This comment was:
- originally posted on idea 'Refresh REST Service Swagger definition of previous consumed version' (created on 21 Jul 2020 by Daniël Kuhlmann)
- merged to idea 'Consume REST services: Update API methods' on 14 Sep 2020 10:28:47 by Fernando Moitinho
Merged this idea with 'Refresh REST Service Swagger definition likewise as possible for SOAP wsdl definition' (created on 21 Jul 2020 06:48:00 by Daniël Kuhlmann)

This comment was:
- originally posted on idea 'Refresh REST Service Swagger definition of previous consumed version' (created on 21 Jul 2020 by Daniël Kuhlmann)
- merged to idea 'Consume REST services: Update API methods' on 14 Sep 2020 10:28:47 by Fernando Moitinho

It would be nice if a REST Service wsdl could be refresh, and that the methods and parameters of existing implementation would automatically be updated.

For SOAP service WSDL is this already possible.



This comment was:
- originally posted on idea 'Refresh REST Service Swagger definition likewise as possible for SOAP wsdl definition' (created on 21 Jul 2020 by Daniël Kuhlmann)
- merged to idea 'Refresh REST Service Swagger definition of previous consumed version' on 23 Jul 2020 00:57:49 by Justin James


This comment was:
- originally posted on idea 'Refresh REST Service Swagger definition of previous consumed version' (created on 21 Jul 2020 by Daniël Kuhlmann)
- merged to idea 'Consume REST services: Update API methods' on 14 Sep 2020 10:28:47 by Fernando Moitinho

Yes. This would be great. Having to delete and then re-import when the swagger updates is annoying. 



This comment was:
- originally posted on idea 'Refresh REST Service Swagger definition of previous consumed version' (created on 21 Jul 2020 by Daniël Kuhlmann)
- merged to idea 'Consume REST services: Update API methods' on 14 Sep 2020 10:28:47 by Fernando Moitinho
Changed the status to
Implemented
on 25 May 2021


Hi Laura! Thanks for the feedback - long overdue but I am happy to let you know that Refresh REST services capability is available in the most recent Service Studio version.


Please, keep the feedback and new ideas coming!

I don't think Laura will have much use for this anymore, as her profile says her last login was four years ago :). But many of us, including me, will be very thankful :D.

views
2870
Followers
15