Forum Discussion

New Contributor

3 years ago

How to add a vendor's Rest API to a project (Newbie)

Ok, I've worked with SOAP API's and now I'm trying to work with a REST API.

I've created a new project, I click to Import API Definition.

I enter the URL of the API, I leave Protocol to Determine Automatically and click Import API.

The screen flickers and then I get a message box "Failed to import a definition".

Is there somthing I need to add to the URL to get the definition? (e.g. ?WSDL)

nmrao
3 years ago
It is called swagger definition of the API's

It can be in a file or a url. Of course, one can save file from url and load into to the ReadyAPI too.

nmrao
Champion Level 3
3 years ago
Do you mean you imported the swagger definition? Have you checked the logs to see what caused errors?
- BFasano
  New Contributor
  3 years ago
  No, I put the URL of the API and it fails.
  Ok, so I looked into it some more and based on what you asked, it sounds like there should be a somefile.json at the end of the URL, is that right?
  Is there a standard name for that file?
nmrao
Champion Level 3
3 years ago
It is called swagger definition of the API's

It can be in a file or a url. Of course, one can save file from url and load into to the ReadyAPI too.
BFasano
New Contributor
3 years ago
Thanks,
I'll reach out to the vendor to get teh file name or full URL.