18
Views
4
Comments
Configure API Base URL
Application Type
Traditional Web
Service Studio Version
11.9.1 (Build 33436)

We are providing a number of API's so that we can integrate with other services as easy as possible.

To try this out I initially set up a simple API based on a list of contacts. I end up with two simple (GET) URL's such as the following, both work as expected:

1. ./ClientPortal/rest/v1/contacts/

2. ../ClientPortal/rest/v1/contacts/{email}

The base URL = /ClientPortal/rest/v1

What I'd like to know is if I can adapt the base URL in any way? From what I've read the "rest" part has to remain and the other two are dependent on the module name  (ClientPortal) and  the version number (v1).

For example could I have something like = /api/v1 which maps to /ClientPortal/rest/v1?

I see there is a possibility to use SEO Friendly URLs, would that work in this respect? If so are there any downsides to this?

I also tried setting up a reverse proxy using NGINX and re-writing URL's but haven't got it working yet. The errors usually to do with swagger libs not being found properly when accessing the swagger documentation page.

Are there perhaps other approaches or ideas to get this working?

mvp_badge
MVP
Rank: #2

Hi Colin,

As far as I know this isn't possible. The path for an expose REST service will always contain the Module name followed by /rest, followed by the name of the REST API (which could be "v1" as in your case, though if you have more than one API in the same module, that wouldn't work of course).

I'm not sure about SEO friendly URLs though, that might work. Did you try it already?

mvp_badge
MVP
Rank: #72

Hi Colin,

Here's a discussion around this topic you might find interesting.

Regards,

Nordin