Creating json descriptor from REST api hosted locally

  • 18 March 2020
  • 4 replies
  • 82 views

I want to create a Json Descriptor File. The REST Api i am using is Locally hosted on a server, now I tried using http://editor.swagger.io/#/

It does not seem to work, Please is there a swagger editor I can install locally so I can use it to find the json descriptor. Please i need advises here.

 


4 replies

Hi Gozni,


 


May we know on what do you mean by it does not work ? Can you give us more details on this so that we can a better view of the situation and find a suitable solution/suggestion for your issue


 


Should you feel that this post is of use and or an accurate solution to the raised question, I kindly encourage you to mark it as such
using the 'Mark as Solution', 'Kudo' andor ‘Me Too’ options.


 


Cheers,
Kate


 


K2 will not accept any liability for any issues arising from actions taken in respect of the information provided by any forum member.


@kateV wrote:

Hi Gozni,

 

May we know on what do you mean by it does not work ? Can you give us more details on this so that we can a better view of the situation and find a suitable solution/suggestion for your issue

 

Should you feel that this post is of use and or an accurate solution to the raised question, I kindly encourage you to mark it as such
using the 'Mark as Solution', 'Kudo' andor ‘Me Too’ options.

 

Cheers,
Kate

 

K2 will not accept any liability for any issues arising from actions taken in respect of the information provided by any forum member.


 

The REST API i am using is uploaded to IIS on a local server. Now I wanted to create a JSON Description file from that REST API and use it to create a smartObject so I can use that same SmartObject in my form or Workflow. When I take the REST api url and put it into http://editor.swagger.io/ in order to generate the description file that I can use to make a smartobject it does not show where to download the JSON File.

 

Thats what I mean by its not working. What must I do in this case

Hi there  @Gozni 


 


I am not 100% with this but it is worth a try.


 


What you would have to do in order to download a json file is to follow this steps:


 



  1. Navigate to File  in the   http://editor.swagger.io/ site.

  2. then after clicking file,  in the drop down click convert and save as Json


After this step your json flie will be downloaded and you will have its location.


 


Then Use the Swagger file (the json file you just downloaded) to register a REST broker service instance. 


you can have a look at attachmentB2 for reference. 


Remember : the Descriptor location- Required is the location of your Json file 


 


Then  make  SmartObject from this service instance in your designer.


 


Let me know if this helps!


 


Regards 


HulisaniN




@HulisaniN wrote:

Hi there  @Gozni 

 

I am not 100% with this but it is worth a try.

 

What you would have to do in order to download a json file is to follow this steps:

 

  1. Navigate to File  in the   http://editor.swagger.io/ site.
  2. then after clicking file,  in the drop down click convert and save as Json

After this step your json flie will be downloaded and you will have its location.

 

Then Use the Swagger file (the json file you just downloaded) to register a REST broker service instance. 

you can have a look at attachmentB2 for reference. 

Remember : the Descriptor location- Required is the location of your Json file 

 

Then  make  SmartObject from this service instance in your designer.

 

Let me know if this helps!

 

Regards 

HulisaniN


 

Thanks but this works for REST Api over the internet. In this Case the REST API is on the local server on our LAN. that seems to give me the confusion here. I tried this for the REST API on the LAN and this does not seem to work. It Behaves like I did not even do anything.

Reply