Recommended Shared Flows For All Proxies

[davissean]

When demand from a single API development team grows, they might choose to distribute the development across multiple teams. How can they ensure consistency in standards, naming conventions and code reuse?

One approach is to provide an API Proxy template. Teams can create a copy of this template for every project manually or via an automated script. This template could contain the following:

• Support for CORS headers
• Error handling patterns followed
• /ping and /status Monitoring Endpoints included
• 404 Resource Not Found
• Security checks such as API Key or Token Validation
• Standardized Logging policy
• Setting common headers such as X-Correlation-Id or X-Apigee-Region
• Setting Spike Arrest to protect backends

• Inclusion of standard build and deploy tools
• API linting, extended to add your own rules
• Unit testing
• Integration testing
• Continuous integration pipeline definition

There are a few different examples of projects following best practices:

- Currency V1

- Apigee Bootstrap

I advise you create your own template, depending on your own requirements and standards.

Remember - if you use Shared Flows, it will be much easier to update your template over time and apply the changes to all proxies!

[olofhaglund]

Be careful of how you do CORS in a shared flow. It can bite you from behind if you are not careful. We had CORS in a shared flow and after a while when we added more and more services it gave us more and more problems.

Now we let the backend services handle the CORS themselves and then in Apigee modify the CORS to add the headers Apigee requires.