We do have multiple write ups on naming the Apigee API based on REST Best practices, but when it comes to some of situation listing down how we derive @ correct naming conventions may be based on required situations.
1. Naming the Apigee Proxies same as backend functionality, which it invokes (eg: Apigee calls backend -say Spring Boot Service , hence name of Apigee Proxy same as name of Spring Boot Service .If Spring Boot Service is made up of multiple APIs (Functionality), Overall SpringBoot service was made based on Business Domain and multiple API which may change or move out of SpringBoot Service, which remains black box for Apigee Proxies.
2. If Spring Boot Service is the Swagger/OpenAPI then we can use the same one for creation of Apigee Proxy. This will create one Proxy for one SpringBoot Service (as per Swagger/OpenAPI Spec). Eg 1 to 1 mapping of Apigee proxies with Spring Boot Service, not Apigee Proxy to API of Spring Boot Service.
3. The reason of naming Apigee Proxies same as Spring Boot Service is, Client understand the SpringBoot Service (as a business functionality) hence its better to maintain them same when exposing as Proxies from Apigee.
4. Yes there are cases where Apigee Proxies is verb in such cases but business requirement will override such known practices, because Business understand the busines functionality based on that naming conventions (few services not migrated to SpringBoot Service patterns).
Any comments ?
LinkedIn
Twitter
