00:00: Hi! Welcome to the tour of API Explorer in WaveMaker. In this video we will walk you
through the User interface of the API workspace. And
00:09: to help us with the tour, we shall see the import of different types of APIs.
00:14: So, Let's get started
00:16: Let us first navigate to the API workspace.
00:21: Let's see what we have here.
00:22: On the left-hand side we see two sections at the top core apis and below is the section called imported apis.
00:31: In the core apis section we see Java service and security service.
00:36: All your Java services in your project will be listed here and your Security Services will be listed in the security service table.
00:44: In the imported API section, there are three tabs API bundles, rest apis and web socket.
00:51: Let's import some APIs.
00:54: So the import apis button brings us to this dialogue.
00:57: Where it gives us option to import API bundles, that is Swagger import.
01:03: Then rest apis like get apis post apis, etc.
01:08: And lastly web socket here we can import websocket services.
01:12: Let's try to import an API Bundle.
01:15: I have a Swagger file that we will upload, to import the API bundles defined in it.
01:20: I am selecting the file from my file storage.
01:24: And then I hit next. The file is read and we are taken to the API listing UI.
01:30: At the top you can give a name to the service bundle that you will import this will help you identify the service later on.
01:37: And below that in the left-hand side all the entities in the bundle are listed in a navigation bar clicking on any of these will expose the apis related to that entity.
01:48: You can click on them and explore.
01:50: You can expand these APIs and see their details, like, description of the Endpoint, it's Parameters and so on.
01:56: So let's click on import to add this bundle into our project.
02:01: On successful import, in the settings tab, we see
02:04: Now, let's move to the End points tab. We see all the entities here and their endpoints.
02:09: I am going to the Customers entity and expanding it's, Get Customer endpoint
02:16: Let's click here and try it out
02:21: Selecting for one page in the parameters and leaving the rest as it is.
02:25: Let's execute the call.
02:30: Here we can check the Curl, and below is the request URL
02:38: And further down is the response.
02:53: Let us explore a Post API. Let's see what we get on trying it out.
03:00: In the parameters, we can provide a sample payload and try it out
03:04: Now let us try other types of API import.
03:08: This time we will import a Rest API. So let's start with clicking on Import AP eyes. And then, we chose Rest AP eyes.
03:16: In this form we have to feed the API URL. I have a get API which is hosted in a remote server. I am going to use that URL.
03:25: I am feeding the URL here
03:29: Now we have to choose the API type, like, get, Post, Put, update and so on.
03:34: Now we have to try it out and fetch the response. So let's click "Test".
03:39: So the server has responsed with the response. And we can check it out in the response body.
03:45: Let us give a meaningful name to the service. So that we can identify it easily among other services
03:57: And now it's time to import the API into our project, so let's hit import.
04:02: You can see the newly service created services listed in the rest API section.
04:14: So, let's go to the third type of API and that is a web socket. And as we all know a web socket is a way for a browser and a server to talk to each other instantly both ways over a single open connection.
04:29: We will see how and where a web socket is imported into a wave maker project.
04:31: In this dialogue we have to provide the websocket url, which is usually in the WSS protocol.
04:37: So the dialogue prompt bar, prompts us to provide a Valid Websocket Endpoint.
04:42: I have put up a web socket server in the localhost and I am providing it here.
04:47: Since it is a insecure AWS URL and our studio is a secure https hosting we cannot test it yet. We can only test it after the import.
04:58: So I am choosing proceed witho testing. And hitting next to proceed to the next step.
05:04: We can see the URL that we provided. And it is asking us to give a meaningful name to the service. So all good. And now, we are ready to import
05:14: So let's hit import.
05:15: Now, that we have imported the Websocket service, into the project. We can proceed for testing.
05:21: So you can see the server is constantly being pinged and it is returning with the response.
05:27: The service that has been put up in the web socket is a random number generator.
05:32: So the data is coming in continuously in the provided time interval.
05:37: So with this we have seen the import of a websocket service.
05:40: this concludes the tour of the API Explorer
05:44: we saw how different API types can be imported explored and tested within a single workspace and how endpoints parameters and responses can be reviewed before use.
05:55: We also observed the import flow for web socket services where testing is performed after a successful input.
