GCP API Gateway: Cannot use path params

Question

I'm struggling to pass the path params from my gateway to the actual endpoints.

Here is my Open API yaml:

swagger: '2.0'
info:
  description: |
    Blah blah
  version: 0.0.1
  title: SSAuth
  contact:
    email: [email protected]
schemes:
  - https
produces:
  - application/json
paths:
  /v0/auth/users/echo:
    get:
      summary: check the health of api
      operationId: healthCheck
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        200:
          description: OK
      x-google-backend:
        address: https://path-to-my-cloud-run-service/v0/auth/users/echo
      security:
        - api_key: []

  /v0/auth/users/type/{type}:
    post:
      summary: Add a new user to the user
      operationId: addUser
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: type
          in: path
          description: provider type of the user
          required: true
          type: string
      responses:
        400:
          description: Invalid input
        200:
          description: OK
      x-google-backend:
        address: https://path-to-my-cloud-run-service/v0/auth/users/type/`type`
      security:
        - api_key: []

securityDefinitions:
  api_key:
    type: apiKey
    name: X-API-Key
    in: header

When I GET the first path, it works. But in the second path, there is a path param that I cannot find a way to pass to params to my Cloud Run URL. In the log, I see this https://path-to-my-cloud-run-service/v0/auth/users/type/%60type%60?type=email instead of https://path-to-my-cloud-run-service/v0/auth/users/type/email, and that cause my service to reject due to invalid type.

What do I need to change in my yaml to make this work?

Son Nguyen · Accepted Answer · 2020-11-12 16:45:06Z

13

Found the solution after digging here.

It's the path_transaltion, here is the working yaml:

swagger: '2.0'
info:
  description: |
    Blahblah
  version: 0.0.1
  title: Title
  contact:
    email: [email protected]
schemes:
  - https
produces:
  - application/json
paths:
  /v0/auth/users/echo:
    get:
      summary: check the health of api
      operationId: healthCheck
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        200:
          description: OK
      x-google-backend:
        address: https://path-to-my-service
        path_translation: APPEND_PATH_TO_ADDRESS
      security:
        - api_key: []

  /v0/auth/users/type/{type}:
    post:
      summary: Add a new user to the user
      operationId: addUser
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: type
          in: path
          description: provider type of the user
          required: true
          type: string
      responses:
        400:
          description: Invalid input
        200:
          description: OK
      x-google-backend:
        address: https://path-to-my-service
        path_translation: APPEND_PATH_TO_ADDRESS
      security:
        - api_key: []

securityDefinitions:
  api_key:
    type: apiKey
    name: X-API-Key
    in: header

edited Nov 12, 2020 at 16:45

answered Nov 12, 2020 at 14:06

Son Nguyen

1,6902 gold badges17 silver badges28 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Praditha Over a year ago

have you tried with PUT and DELETE method? I always getting Cannot PUT /users/{user-id} error

Soumik Das Over a year ago

Exactly what I am looking for. It works for me as well. Thanks.

Pravin Maske Over a year ago

I was facing same issue, was integrating my Google Cloud Run Service from Google API Gateway. have used path parameters, and was getting "GET /?id=4 HTTP/1.1" 404 Not Found instead of "GET /query/4 HTTP/1.1" 200 OK. adding path_translation: APPEND_PATH_TO_ADDRESS under x-google-backend: fixed the issue. Thank!!

Collectives™ on Stack Overflow

GCP API Gateway: Cannot use path params

1 Answer 1

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related