This website uses Cookies. Click Accept to agree to our website's cookie use as described in our Privacy Policy. Click Preferences to customize your cookie settings.
Accept
Reject
Preferences
Log in to ask a question
Log in to ask a question

Apigee API Platform Learning Guide

on ‎12-15-2023 07:00 AM - edited on ‎12-19-2023 12:42 PM by

epbgonzalez
Staff
3 2 1,415

Purpose of this Guide

* This is an updated version of the guide for Apigee X/Hybrid. You can find the original article under  goo.gle/apigee-edge-guide

The information in this guide will help you gain the knowledge necessary for design, development, and management of APIs on Google Cloud's Apigee X & Hybrid platform. It will help you learn about API design and documentation best practices, as well as the features of the Apigee platform, including its AI-powered automation and integrated security capabilities.

Training Content

API Developer Learning Path with Apigee - with this course you will learn how to develop and manage APIs to build new applications and connected experiences using Google Cloud's Apigee API management platform. Visit Google Cloud Skills Boost to sign up for the course!

Cloud Architect/Engineer Learning Path for Apigee - A Cloud Architect or Engineer on Apigee utilizes the Apigee API Platform to enhance their cloud architecture and enterprise solutions. This learning path guides you through a curated collection of on-demand courses, labs, and skill badges that provide you with real-world, hands-on experience using Apigee. Visit Google Cloud Skills Boost to sign up for the pathway!

Topics

This document lists most of the important topics useful for an Apigee API Engineer, presenting links to the content with short descriptions. The information is organized by topic. At the end of this document is a List of Resources by Source, which will provide the same links organized by source. Note: Apigee API Engineer training will cover many of these topics, and some of the webcasts and eBooks will cover topics also explained in the online docs.

Getting Started

Certain resources should be viewed by every Apigee API developer. If you are just getting started with Apigee, these will give you a good foundation. Even if you are an experienced Apigee developer, you may find important concepts in these materials.

Note: Each of these documents is also listed in the topic-specific sections below.

Getting Started with Apigee API Management - Video tutorials for getting started with Apigee API management.

Apigee Online Docs - Get started reading our official documentation for Apigee.

Apigee Accelerators - Accelerator videos to help you get started with Apigee in 5 minutes.

Apigee Community - Community for asking and answering questions related to Apigee and API development.

General Resources

Understanding APIs and API Proxies - Overview of APIs and proxies.

Understanding organizations - Describes the components that make up an Apigee  X / Hybrid Organization.

Understanding routes - Overview of routes, which determines which TargetEndpoint will be used.

About environments and environment groups - Overview of environment groups. 

Controlling how a proxy executes with flows - Explains the flow of a call through a proxy.

What is an API product? - Introduction to API Products

Analytics Services overview  - This topic introduces Apigee API Analytics

Glossary - Glossary of Apigee terms.

Apigee Naming Conventions - Naming conventions for code, proxies, key/value maps, etc.

Apigee API Program Excellence

The Apigee API Program Excellence e-learning playlist on Youtube teaches you about what is required to build a great API Program. This course teaches you what Apigee's Digital Engagement Lead team does, and is recommended for API Engineers who are interested in expanding beyond the technical aspects of API Management into the business and strategy aspects of API programs.

API Design Best Practices

Best practices for API proxy design and development - A great list of best practices to follow when designing API proxies. Be sure to drill down into links you find in this document.

API Design: Third Edition - A classic webcast discussing API design patterns.

Web API Design: The Missing Link - API design best practices - an excellent overview of API design concepts.

API Facade Pattern - Description of the façade pattern that can be implemented using Apigee X / Hybrid.

Apigee Anti-Patterns - Some useful anti-patterns and solutions for Apigee X / Hybrid development. I recommend downloading the Anti-Patterns ebook that can be found at this link.

OpenAPI Specification 3.0 and API Documentation Best Practices

Create an API proxy from an OpenAPI Specification - Tutorial to create a proxy from an OpenAPI spec.

Best Practices for Defining an API Specification - Practices you should follow in regards to documenting and managing the specification including the API design. 

Apigee X / Hybrid Policies

Policy reference overview - Top level index of all policy reference pages. Drill down into the policy-specific pages to see the options available for each Apigee policy, as well as when each policy should be used.

JavaScript object model - Object model for JavaScript policies, including access to flow variables.

Comparing Quota, Spike Arrest, and Concurrent Rate Limit Policies

OAuthV2 policy

JWT policies

SAML Assertion policies

How to create a Java callout - Cookbook for creating a callout.

Policy error reference - Error messages and flow variables set when policy errors occur.

Apigee X / Hybrid Proxy Design

Understanding APIs and API Proxies - Overview of APIs and proxies.

API proxy configuration reference - Reference of proxy structure.

Endpoint properties reference - ProxyEndpoint and TargetEndpoint configuration properties.

Variables reference - Predefined variables available within proxies.

Conditions reference - Conditions enable dynamic control of proxies.

About message templates - String substitution via variables and functions within policies and endpoint elements. 

Understanding organizations - Describes the components that make up an Apigee organization.

Best practices for API proxy design and development - A great list of best practices to follow when designing API proxies. Be sure to drill down into links you find in this document.

Understanding routes - Overview of routes, which determine which TargetEndpoint will be used.

About environments and environment groups  - Overview environments and groups in Apigee. 

Controlling how a proxy executes with flows - Explains the flow of a call through a proxy.

Managing proxy state with flow variables - Description of use of flow variables in proxies.

Handling faults - Description of fault handling in Apigee.

Working with key value maps - Includes encrypted and unencrypted KVMs.

Support for HTTP response header (ResponseCache) - Use of caching headers.

Working with cache keys - Cache key details.

Cache internals - Implementation of caches in Apigee.

Reusable shared flows - How to create and use shared flows for code reuse. Also see Attaching a shared flow using a flow hook.

Chaining API proxies together - Tutorial on proxy chaining.

Manage resources - How to understand and manage resources

Glossary - Glossary of Apigee terms.

Error Handling Pattern for Proxies - Describes a clean way to handle creation of error messages within your proxy.

API Products, Developers, and Apps

Create API products - Also see What is an API product?

Managing app developers

Register apps and manage API keys

Making sense of API product configuration

Apigee Analytics

Analytics Services overview

Using the analytics dashboards - Use of the Apigee Analytics UI. 

Analytics metrics, dimensions, and filters reference

Apigee Troubleshooting and Debugging

Using the Trace tool - Using the trace tool for debugging proxy issues.

Troubleshooting Playbooks - Guides for troubleshooting Apigee, and troubleshooting FAQs.

Apigee Troubleshooting Videos - Videos to help with common troubleshooting scenarios.

Policy Playbooks - Complete error description and troubleshooting guidance for Apigee runtime and deployment policy errors.

Product limits - Product Limits information

Apigee Deployment and Environment Promotion

API development lifecycle - Overview of API Lifecycle using Edge environments.

apigeecli - This is a tool to interact with the Apigee APIs. The tool lets you manage (create, delete, get, list), environments, proxies.

Apigee + Terraform

Apigee Terraform Modules - Terraform Modules ready to use end-to-end for Apigee

Apigee Terraform Resources -  Apigee Terraform resources listed under the Google provider. 

Apigee Developer Portal

There are two types of developer portals: Drupal-based and integrated. The Drupal-based portal is more powerful, and the integrated portal is easier to use.

Developer Portal Solutions - Overview of developer portals.

Integrated developer portal documentation

Drupal developer portal FAQ

Apigee Monetization

Understand monetization - Summary of the monetization feature available in Apigee. 

Steps to use Monetization 

Enabling Monetization

Generating Monetization Reports

API Security Topics and Best Practices

OAuth2 - This is the landing page for a wealth of topics on OAuth 2.

API keys - An overview of API key validation for APIs.

OAuth: The BIG Picture - Overview of when, how, and why to use OAuth.

About TLS/SSL - Description of one-way and two-way SSL/TLS terminology and flows. Keystores and Truststore information.

Data masking and hiding - Description of features in Apigee that control visibility of data in logs and tracing.

Using Third-Party OAuth Tokens - How to use third-party OAuth tokens within Apigee.

Advanced API Security - Apigee Advanced Security capability for organizations looking for more in depth security stances. 

API Lifecycle Topics and Best Practices

Automating API delivery with CI/CD pipelines why you should add your APIs to your CI/CD pipelines as well as some recommended tools.

A Checklist for Every API Call - Topics to be considered for every API.

Digital Business Survival Guide - Guide to building an API program.

The Digital Transformation Journey - Insights into digital transformations of several companies.

Continuous Integration for API Proxies - Overview of continuous integration for APIs.

Forming an API Test Strategy - Where to Start - Getting started with API testing.

Apigee CI/CD with Cloud Source repositories, Cloud Build, and Cloud KMS - An example of how to use Google Cloud as your CI/CD pipeline.

Apigee Adapter for Envoy 

Apigee Adapter for Envoy  - Getting started with the Apigee Adapter

List of Resources by Source

Apigee Online Docs

Apigee eBooks

Apigee Webcasts

Apigee Community

Apigee Blogs

Apigee Cloud Architecture Center

Github

Youtube Videos

Other

 

 

Topic Labels
Comments
CatFix
Bronze 5
Bronze 5
‎12-22-2023 08:44 PM

This is awesome! Thank you!
borat-high-five.gif

christopherkarl
Staff
‎03-11-2024 10:17 AM

This is a fantastic guide😍 Thanks for sharing to the community @epbgonzalez 

Version history
Last update:
‎12-19-2023 12:42 PM
Updated by: