Professional Cloud Developer
Professional Cloud Developer
Intermediate
Gauge your current knowledge
Intermediate
Gauge your current knowledge
Versioning, exposing and securing APIs in applications (e.g., Apigee)
...
Professional Cloud Developer
Gauge your current knowledge
Gauge your current knowledge
Apigee is an API management platform that helps developers design, secure, and scale their application interfaces. The platform uses the OpenAPI Specification to define a clear contract for how services should be accessed, which is essential for maintaining consistency as cloud-native applications evolve.
To control who can access an API, developers implement security protocols like OAuth 2.0 and OpenID Connect (OIDC). These authentication frameworks verify that only trusted users or services can interact with sensitive data. Common security measures include API key validation (verifying unique strings assigned to clients), OAuth scopes (limiting specific actions a user can perform), and JWT verification (checking digital signatures on identity tokens to ensure they have not been tampered with).
When deploying applications to Cloud Run, developers use IAM to manage permissions. Rather than using permanent service account keys, which pose security risks, developers should use short-lived credentials and service accounts following the principle of least privilege. This means the Cloud Run service receives only the exact permissions it needs to access other Google Cloud resources.
Threat protection policies defend against common vulnerabilities like injection attacks or unauthorized data access. VPC Service Controls create a security perimeter that prevents data exfiltration by restricting how data moves between services. Implementing these guardrails early in development helps mitigate risks before the application goes live.
Managing an API requires understanding its lifecycle, which includes stages like Stable, Beta, and Deprecated. Stable endpoints are reliable and rarely change, while Beta endpoints are still being developed and may have breaking changes. Developers use semantic versioning to track these updates, often employing a URI versioning strategy that keeps the original endpoint unchanged. This approach maintains backward compatibility so older applications do not break when a new version is released.
When migrating to a new version, developers must audit their code to find structural changes in data types or function names. In compiled languages, these issues appear as compile errors, but dynamic languages like Python require runtime unit tests to catch bugs. A systematic deprecation schedule gives users enough time to update their applications. This process includes mapping old endpoints to new resource-oriented designs, updating service URLs and authentication methods, and testing the integration in a staging environment.
API keys should not be provided as query parameters in URLs because they can be easily stolen through browser history or logs. Instead, use the x-goog-api-key HTTP header or a client library to pass credentials securely. Implementing strong monitoring and logging helps detect unauthorized usage and keeps data safe.
Google Cloud provides tools like Apigee, API Gateway, and Cloud Endpoints to manage and protect interfaces. Apigee is an enterprise-scale platform offering advanced security features like threat protection and OAuth 2.0. When deploying applications to Cloud Run, Cloud Endpoints helps with monitoring and tracing for API calls.
Apigee provides a secure proxy layer between users and backend services. By using an API proxy, developers create a facade that hides backend complexity while adding essential features. This setup allows teams to expose services securely without changing the underlying application code.
Individual proxies are grouped into API products, which serve as the central mechanism for authorization. An API product bundles proxies together with a specific service plan defining how they can be used. Developers register their applications to receive an API key, which is required to authenticate every request.
Apigee uses policies to maintain performance and availability. Traffic management tools include Spike Arrest (protecting against sudden traffic surges by limiting request rates), Quotas (enforcing long-term consumption limits based on business contracts), and Response Caching (storing frequently accessed data to reduce latency and decrease backend load).
Securing interfaces involves multiple protection layers, including OAuth 2.0 and Transport Layer Security (TLS). These tools ensure only authorized users access sensitive data while keeping communication encrypted. Threat protection policies and role-based access control further protect API configurations.
API lifecycle management requires strategic versioning to ensure updates do not break existing client applications. By managing different versions of an API product, organizations roll out new features while maintaining support for older implementations. This process is vital for deploying applications to environments like Cloud Run where scalability and consistent performance are required.