API proxy base path changes when moving from Lower Environment to higher Environment. Is it correct Design REST practice ?

[abiramradhakris]

As per Apigee Docs which indicates following information about Proxy Base Path

*******************

After you create an API proxy on Edge, the default URL that an app uses to access the proxy has the form:

http://{org-name}-{env-name}.apigee.net/{base-path}/{resource-path}

https://{org-name}-{env-name}.apigee.net/{base-path}/{resource-path}

·{org-name} is your organization name. This name is created when you create an account on Edge.

·{env-name} is the Edge environment name. By default, all Apigee organizations created in the cloud are provisioned with two environments: 'test' and 'prod'. When deploying an API proxy, you can choose to deploy it to one or both environments.

·{base-path} and {resource-path} are defined when you create the API proxy.

This is what I understood of Base Path

1.The second part of the URL, /v1/weather, is determined by the <BasePath> element in the ProxyEndpoint. The base path must be unique to the API proxy for the environment so that two API proxies do not have the same base path.

**********

1. Dev Env

I would like to know say in Dev Env if the Base path of above listed Proxy is

/v1/weather

Then the Proxy full url in Dev willl be as below (just an example)

http://{org-name}-{env-name}.apigee.net/v1/weather/{resource-path}

2. QA Env

http://{org-name}-{env-name}.apigee.net/v1/api/weather/{resource-path}

3. UAT Env

http://{org-name}-{env-name}.apigee.net/v1/uuzzapi/weather/{resource-path}

As you can see that same proxy the base path in Dev Environment is different than, what's listed in QA Env and finally in UAT the proxy base path is again changed and may be in prod not sure which base path will be followed for same Proxy or may remain same as given in UAT, I have no clue.

Q1.Does Base path of given Apigee SaaS Proxy will change when it moves from one Env to another Env (ie from Dev to QA to UAT Env ?)

If that is correct ? , what will be reason that Base path of given Apigee proxy will change when moving from one Env to another ? Is that correct REST or design practice ? Is it documented in any REST BEST practices did not really hint like that and hence not sure.

Q2: If Proxy Base path when moving from one Env to another Env changes what will be the reason ?

I understand that Proxy base path for given proxy should be unique within given Env, but I am not sure, why it should change when moving from one Env to another Env (overall its unique in single Env but Proxy base path changes when moving from Lower Env to Higher Env )

This triggers coding changes for proxy to change on base path when moving it from one Env to another Env.

I may try put proxy base path information to KVM or may be can be automated when moving from one Env to another Env, but I am not sure if that correct practice.

[robert]

Q1.Does Base path of given Apigee SaaS Proxy will change when it moves from one Env to another Env (ie from Dev to QA to UAT Env ?)

No. Base path is same when promoting a proxy from one environment to another. If it's /v1/weather in DEV, then it's /v1/weather in QA and PROD as well.

Q2: If Proxy Base path when moving from one Env to another Env changes what will be the reason ?

See Q1 answer.

[abiramradhakris]

Thanks @Robert Johnson do we have the any such defined write up from apigee docs or from REST practice indicating this practical case, where write up indicates that base path should not change, when moving from one Env to another Env ? any why ? or business can decide to change

There are times when we say Resource name should be Plural Nouns but for few services there comes a exception indicating not following plural nouns makes business sense.

Do we have any context like that for Proxy path, or its a mandatory rule ?