search

zowe / sample-spring-boot-api-service

Zowe REST API service SDK and sample API service that integrates with Zowe API Mediation Layer
Other
26 stars 18 forks source link

URI Pattern Inside and Outside of API ML #66

Closed dkelosky closed 4 years ago

dkelosky commented 4 years ago

If we follow this: 

   routes:
        - gatewayUrl: api/v1
          serviceUrl: /api/v1

We may have an endpoint outside of the API ML that is: /api/v1/status.

Then, through the API ML, we would then have /api/v1/servicename/status

A concern is that this might make it difficult to be a client for both cases. Is that valid or is this normal in an API ML?

plavjanik commented 4 years ago

What would you suggest?

To have /serviceid/api/v1/status at the API Gateway?

That would make more sense to me now. If we want to change it, we have to discuss it with the API squad and do it before LTS.

dkelosky commented 4 years ago

It's a pretty disruptive change, but I think it would be less confusing to teams. I can ask them to comment here, would that be helpful?

plavjanik commented 4 years ago

I think that the issue should be opened in zowe/api-layer. SDK just follows it. If API squad agrees that it is feasible to change it and what options makes sense then we should ask. There can be many implications of changing the format so we should present only the options that we can implement with reasonable effort.

dkelosky commented 4 years ago

Good point - I copied the issue there and will close this one. Thanks