nav-img
Advanced

Overview

This document provides a comprehensive guide to using API Gateway (APIG), including service overview, getting started, operation guide, and FAQs.

  • Service Overview describes the definition, advantages, and scenarios of APIG.
  • In Getting Started, simple authentication with an app is used for illustration.
  • The user guide describes how to perform operations on the console.

    There are two APIG entries on the console:

    • Choose Service List > Application > Dedicated API Gateway to access the APIG console, where only dedicated gateways are available and they are featured with new UI. For details about how to use them, see User Guide (Dedicated API Gateway).
    • Choose Service List > Application > API Gateway to access the APIG console, where both the shared gateway and dedicated gateways are available. The dedicated gateways here are featured with old UI. For details about how to use the shared gateway and dedicated gateways on the old console, see User Guide (API Gateway).

    For differences between the dedicated gateways on the new and old console, see Comparing Versions. For differences between the shared gateway on the old console and dedicated gateways (old and new console), see Specifications.

  • FAQs describes common issues that may occur when you use APIG.
Note

Dedicated gateways on the old and new console are now only distinguished in the user guide. The service overview, getting started, and FAQs are based on the dedicated gateways on the new console. If you are using dedicated gateways on the old console and need to refer to the preceding manuals, see User Guide (API Gateway).