Skip to Content (Press Enter)
UserImage.jpg
Omar Allam
71Views
4Comments
Solved
How to test exposed REST APIs using swagger "Try Now" button?
Question
Reactive
Service
Application Type
Reactive, Service

When I open the documentation of the exposed REST APIs in swagger, I cannot find a way to test these APIs.

Usually when I open any other swagger documentation (outside OutSystems ecosystem), I can run any API and see the actual response (not a sample JSON object with datatypes).

Is there a way to do that in the documentation generated automatically using OutSystems?

0
0
26 May 2024
Copy Link
2021-11-12 04-59-31
Manikandan Sambasivam
Solution

In OutSystems, the automatically generated Swagger documentation for exposed REST APIs does not natively include the interactive testing capabilities that you might find in other Swagger UI implementations. 

But you can use Postman to import your Swagger documentation and test your APIs interactively.

  1. Export your Swagger JSON file from OutSystems.
  2. Open Postman and go to "Import".
  3. Select the "Link" tab and paste the URL of your Swagger JSON file.
  4. Postman will import your API documentation, and you can test the endpoints interactively.


See solution in context
1
0
27 May 2024
Copy Link
UserImage.jpg
Omar Allam

I thought I could run the APIs directly from swagger. The export/import way is a good idea though.

Thank you so much

1
0
27 May 2024
Copy Link
2024-05-20 09-45-12
Jean Bastos

Hi Allam

You Can not do it directly there.

If you want proper test your API use another tool like postman.



1
0
27 May 2024
Copy Link
2025-10-18 11-13-53
Ramesh subramanian

Hi Allam,

As Jean Bastos mention  correct. Use postman to test REST APIs.


1
0
27 May 2024
Copy Link
2021-11-12 04-59-31
Manikandan Sambasivam
Solution

In OutSystems, the automatically generated Swagger documentation for exposed REST APIs does not natively include the interactive testing capabilities that you might find in other Swagger UI implementations. 

But you can use Postman to import your Swagger documentation and test your APIs interactively.

  1. Export your Swagger JSON file from OutSystems.
  2. Open Postman and go to "Import".
  3. Select the "Link" tab and paste the URL of your Swagger JSON file.
  4. Postman will import your API documentation, and you can test the endpoints interactively.


1
0
27 May 2024
Copy Link
UserImage.jpg
Omar Allam

I thought I could run the APIs directly from swagger. The export/import way is a good idea though.

Thank you so much

1
0
27 May 2024
Copy Link
Community GuidelinesBe kind and respectful, give credit to the original source of content, and search for duplicates before posting.