Skip to Content (Press Enter)
UserImage.jpg
Stephen Schaff
1206Views
11Comments
Can't get swagger docs recognized
Question
REST
I am evaluating outsystems for my company and am having problems with the REST API consume feature.

My REST Service has swagger v2 docs.  I can browse to them on my computer (inside my firewall) and on my phone (outside my firewall).

But when I put in the URL to the Outsystems IDE the error details say:

WebException.ProtocolError: The remote server returned an error: (404) Not Found.

But I literally copied and pasted the URL from my browser where it worked.

I have tried the URL to the actual swagger ui, the url path below swagger, and the url path that points to the swagger json.

The one that seems most likely to work is:
https://mycompanycom/service/path/swagger/docs/v1

When I go there on my phone and computer browser, it starts out like this:
{"swagger":"2.0","info"......

But it 404s in the outsystem module editor...

What am I doing wrong?
0
0
20 Apr 2016
Copy Link
2020-09-15 13-07-23
Kilian Hekhuis
 
MVP
Hi Stephen,

Iiuc, the Platform tries to access the Swagger from the platform server, so not from your local work station that runs Service Studio. Is it possible that the server does not have access to that URL?

Also, in Service Center check the RESTDevService eSpace - if it has any outdated references, republish it, and see if that helps (we had a similar problem, except for a 500 error ("Invalid URI: The URI is empty") i/o a 404).
1
0
20 Apr 2016
Copy Link
2019-10-27 01-32-56
Caio Santana Magalhães
 
MVP

Republishing the RESTDevService eSpace did it for me.


Nice tip. Thanks!


Kilian Hekhuis wrote:

Hi Stephen,

Iiuc, the Platform tries to access the Swagger from the platform server, so not from your local work station that runs Service Studio. Is it possible that the server does not have access to that URL?

Also, in Service Center check the RESTDevService eSpace - if it has any outdated references, republish it, and see if that helps (we had a similar problem, except for a 500 error ("Invalid URI: The URI is empty") i/o a 404).



1
0
04 Dec 2018
Copy Link
2021-04-17 17-51-40
George Jeffcock
Hi Stephen,

ditto get the 404 error on

https://watson-api-explorer.mybluemix.net/listings/alchemy-data-news-v1.json

did you ever work out what the issue was to save me time?

Thanks in advance

Thanks in advanceHi Stephen,
0
0
17 Jun 2016
Copy Link
2021-04-17 17-51-40
George Jeffcock
Can you only use swagger for outsystems exposed api and not public API swagger files? 
0
0
18 Jun 2016
Copy Link
2012-03-16 12-21-09
João Rosado
Staff

Hi Stephen and George,


The problem is the the current version always tries to add a Swagger.json to the end of the url, as that is what the spec required. Unfortunately, most services/frameworks do not follow that part of the spec.

I already removed that restriction but it is only scheduled to be included on the next major version of the platform.


For the current version you will need to use the Swagger Proxy component.
The component allows you to add a url to any swagger documentation and it will create a url ending with Swagger.json for you.


Regards,
João Rosado

1
0
18 Jun 2016
Copy Link
2021-04-17 17-51-40
George Jeffcock
Worked fine using the Swagger Proxy. Thanks João and fun to see how you use the platform itself to help the platform.
0
0
18 Jun 2016
Copy Link
UserImage.jpg
Mariya Paul

when i create a consume Rest api , add all methods and give Rest Api URL: an error occurred

"The swagger file doent have a version specified or version is incorrect"

What It Means?

0
0
31 Jul 2020
Copy Link
2012-03-16 12-21-09
João Rosado
Staff

Hi Mariya,


Can you try openning the url in the browser and see if it had a swagger definition?

That feature requires a rest api that exposes thr documentation in Swagger 2.0 (also supporting OpenApi 3.0 in recent versions os Service Studio)


Normally the swagger documentation can be fetched by adding "/swagger.json" at the end of the url. That is what Service Studio tries if you write the direct url to the api instead of the swagger url.


If you can post the api url or what result you get by calling the swagger url maybe I can advice further.


Regards,

João Rosado


0
0
01 Aug 2020
Copy Link
UserImage.jpg
Udaya Kumar

Hi,

I just got into outsystems and want to explore the options...

While trying to use the services, I get the same issue that Mariya faces.

The URL works in the browser, whereas when I use it in the Studio, it fails. The URL that I use is:

[URL redacted - KH]

Any help in resolving this would be much appreciated.

0
0
16 Jan 2021
Copy Link
2020-09-15 13-07-23
Kilian Hekhuis
 
MVP

Replying to Udaya Kumar's comment on 16 Jan 2021 07:24:15

Hi Udaya,

First, the URL you put there doesn't point to a Swagger definition (the topic of this thread), but to the output of a REST API Method call, so you should really put your question in a different topic.

Secondly, your post included an API key, never ever do that! API keys are secret, and putting them here on the forum allows mallicious use. Therefore, I removed the key from your post.

1
0
17 Jan 2021
Copy Link
UserImage.jpg
Udaya Kumar

Replying to Kilian Hekhuis' comment on 17 Jan 2021 16:27:44

Thanks, Kilian.

As I'm a newcomer to a development environment, I got to learn many things.

0
0
17 Jan 2021
Copy Link
Community GuidelinesBe kind and respectful, give credit to the original source of content, and search for duplicates before posting.