Información sobre las plantillas de ruta

En API Gateway, es posible enrutar las solicitudes entrantes según las plantillas de ruta. La creación de plantillas de rutas tiene tres componentes principales:

• Coincidencia exacta
• Coincidencia de comodines únicos
• Coincidencia de comodines dobles

En las siguientes secciones, se describe cada uno de estos componentes y cómo funcionan dentro del contexto de API Gateway.

Coincidencia exacta

Una ruta de acceso con plantilla sin ningún segmento de comodín único o doble (* o **) se convierte en una coincidencia de ruta de acceso exacta. Por ejemplo, la especificación de OpenAPI para la configuración de la API de tu puerta de enlace puede contener una sección como la siguiente:

...
paths:
  /shelves:
    get:
      summary: List shelves
...

En este ejemplo, la puerta de enlace solo aceptará solicitudes a /shelves y no a otras rutas.

Coincidencia de comodines únicos

Si una ruta de acceso con plantilla contiene una variable, un segmento de comodín único (p. ej., {var} o {var=*}), o ambos, la puerta de enlace permitirá las solicitudes entrantes que cumplan con lo siguiente:

• Las solicitudes no contienen una barra diagonal adicional (/), lo que significa que la variable solo coincidirá con un solo segmento de ruta de acceso.
• Las solicitudes contienen al menos un carácter.
• Las solicitudes pueden contener una barra diagonal adicional al final de la ruta.

Por ejemplo, la especificación de OpenAPI para la configuración de la API de tu puerta de enlace puede contener una sección como la siguiente:

...
paths:
  /shelves/{shelf}/books/{book}: # Equivalent to /shelves/{shelf=*}/books/{book=*}
    get:
      summary: Retrieve a book
...

En este ejemplo, la puerta de enlace aceptará las solicitudes que coincidan con la siguiente regex:

^/shelves/[^/]+/books/[^/]+/?$

Coincidencia de comodines dobles

Si una ruta de acceso con plantilla contiene una variable denotada por un segmento de comodín doble (p. ej. {var=**}), la puerta de enlace permitirá las solicitudes entrantes que cumplan con lo siguiente:

• Las solicitudes pueden contener todos los caracteres, incluidas las barras diagonales (/).
• Las solicitudes pueden contener 0 o más caracteres.
• Las solicitudes pueden contener una barra diagonal adicional al final de la ruta.

Por ejemplo, la especificación de OpenAPI para la configuración de la API de tu puerta de enlace puede contener una sección como la siguiente:

...
paths:
  /shelves/{shelf=*}/books/{book=**}:
    get:
      summary: Retrieve a book
...

En este ejemplo, la puerta de enlace aceptará las solicitudes que coincidan con la siguiente regex:

^/shelves/[^/]+/books/.*/?$

Barras diagonales codificadas en URL

API Gateway sigue la RFC 3986, que no trata las barras diagonales codificadas en URL (%2F) como barras diagonales reales cuando se hacen coincidir las rutas de URL para decisiones de enrutamiento o seguridad. Si se esperan barras diagonales codificadas en URL, tu backend debe controlar estas solicitudes según corresponda.

Por ejemplo, considera la siguiente especificación de OpenAPI:

securityDefinitions:
  api_key:
    type: "apiKey"
    name: "key"
    in: "query"
paths:
  /shelves/{shelf}:
      get:
        parameters:
        - in: path
          name: shelf
          type: string
          required: true
          description: Shelf ID.
        summary: List shelves
        operationId: GetShelf
          responses:
            '200':
              description: A successful response
              schema:
                type: string
    /shelves/{shelf}/books/{book}:
      get:
        parameters:
        - in: path
          name: shelf
          type: string
          required: true
          description: Shelf ID.
        - in: path
          name: book
          type: string
          required: true
          description: Book ID
        summary: Retrieve a book
        operationId: GetBook
          responses:
            '200':
              description: A successful response
              schema:
                type: string
         security:
         - api_key: []

En este ejemplo, la operación /shelves/{shelf}/books/{book} requiere una clave de API, pero la operación /shelves/{shelf} no tiene restricciones.

En caso de que un usuario envíe una solicitud a /shelves/shelf_1%2Fbooks%2Fbook_2, ocurrirá lo siguiente:

• La puerta de enlace procesará la solicitud como una operación GetShelf para el ID de biblioteca shelf_1%2Fbooks%2Fbook_2. En este caso, no se aplica una verificación de clave de API.
• Si el %2F se normaliza antes de que el backend controle cualquier solicitud, es posible que la solicitud se procese como la operación GetBook para el ID de libro book_2. En otras palabras, el backend procesa /shelves/shelf_1%2Fbooks%2Fbook_2 como /shelves/shelf_1/books/book_2.

En este ejemplo, el backend espera que la operación GetBook realice una verificación de clave de API en la puerta de enlace. Sin embargo, como la puerta de enlace leyó la solicitud como una operación GetShelf, no se realizó ninguna verificación de la clave de API.

Normalización de varias barras diagonales adyacentes

API Gateway sigue la RFC 3986, que indica que las rutas con varias barras diagonales adyacentes se tratarán como una ruta de acceso diferente de las que tienen barras diagonales únicas. Por ejemplo, una solicitud que contiene /shelves/// no será normalizada por la puerta de enlace a la ruta de la solicitud /shelves/ antes de hacer coincidir una plantilla de ruta del URI ni cuando se reenvía al el backend especificado.