API Endpoint Creation Request : Portal

W

Wijden DAHMEN

started a topic 3 months ago

I would like to create an API with different endpoints. For example:

/LOVS/search
/LOVS
/LOVS/list

Thank you for your help in advance !

Best Answer

S

Subham Dixit said 3 months ago

Hello Wijden,

Thank you for the clarification, please follow our documentation on this-

https://www.semarchy.com/doc/semarchy-xdi/xdi/latest/Manage/publish-webservice/configure-parameters.html#:~:text=in%20this%20article.-,Set%20HTTP%20paths%20and%20available%20methods,-Web%20services%20are

Have a nice day.

S

Subham Dixit

said 3 months ago

Hello Wijden,

Yes, you can achieve this by using HTTP REST metadata having the base URL as fixed and you can add many Path to it, for example-

This is the Base URL-

Now you can have many Paths, like this-

As you described in your use case, you want to configure the endpoints for-

/LOVS/search
/LOVS
/LOVS/list

So you need to have a common Base endpoint and then create Paths - LOVS/search, /LOVS and /LOVS/list.

Thank you and have a nice day.

W

Wijden DAHMEN

said 3 months ago

Hello Subham,

Thank you for your reply. I would like to publish an API with different endpoints.

S

Subham Dixit

said 3 months ago

Hello Wijden,

In that case you need to create different HTTP metadata to achieve and access different endpoints.

Thanks.

W

Wijden DAHMEN

said 3 months ago

Hello Subham,

I would like to publish an API (not consume an existing one). To achieve this, I created a process, configured it, and deployed it as a web service (WS).

My web service is LOVS.

I would like to create the following endpoints for my WS:

/LOVS/search: GET method to search for data.

/LOVS/: POST method to send data.

/LOVS/list: GET method to list all data.

S

Subham Dixit

said 3 months ago

Answer

Hello Wijden,

Thank you for the clarification, please follow our documentation on this-

https://www.semarchy.com/doc/semarchy-xdi/xdi/latest/Manage/publish-webservice/configure-parameters.html#:~:text=in%20this%20article.-,Set%20HTTP%20paths%20and%20available%20methods,-Web%20services%20are

Have a nice day.