Forum Discussion

llanginger's avatar
llanginger
Occasional Visitor
6 years ago

API gateway integration - proxy server question

Hi there,   I'm attempting to use the api gateway integration extension and am confused as to what "Address of the server to Proxy to*" refers to - please assume for this that the entirety of the...
Nastya_Khovrina's avatar
Nastya_Khovrina
SmartBear Alumni (Retired)

Hi,

 

Amazon API Gateway can work in the proxy mode passing requests to an external API server, or it can use AWS Lambda functions as a backend for API endpoints. SwaggerHub has different integrations for these scenarios:

Amazon API Gateway – Use it if you have an existing API server and you want to proxy or secure it using API Gateway.

Amazon API Gateway Lambda Sync – Use it if you want to use AWS Lambda functions as a backend for your API.

 

For the first type:

Address of the Server to Proxy to – The back-end HTTP endpoint to which API Gateway will proxy the requests. For example, http://api.example.com/reports/v2 or https://myapi.com. If your API definition specifies the host, basePath and scheme, this is scheme:host/basePath.

 

So, it's not necessary to specify the existing server if you don't need to send requests to it.

 

Please see this article for additional details: https://app.swaggerhub.com/help/integrations/amazon-api-gateway

 

raulsann's avatar
raulsann
Occasional Contributor
5 years ago

I'm still confused about what the Address of the Server to Proxy to is.

 

Is this one of the parameters that SwaggerHub gives? or is it a parameter we need to get from the Amazon API Gateway?

  • raulsann's avatar
    raulsann
    Occasional Contributor
    5 years ago

    We are trying to set up the Amazon API Gateway Integration but we are unable to set it up. We don't get any error message so it's hard to know what is going wrong. 

    Could you also advise the better way to debug the integration?

    • Nastya_Khovrina's avatar
      Nastya_Khovrina
      SmartBear Alumni (Retired)
      5 years ago

      Hi raulsann,

       

      Address of the Server to Proxy to – The back-end HTTP(S) endpoint to which API Gateway will proxy the requests. For example:

      http://api.example.com/reports/v2
      https://myapi.com
      Typically, this should be the same value as the API base path specified in your API definition, that is, the server URL in OpenAPI 3.0 or scheme:host/basePath in OpenAPI 2.0.

       

      What other issues do you have? 

      After the integration is run can you see the API in Amazon?

      • raulsann's avatar
        raulsann
        Occasional Contributor
        5 years ago

        Thank you for your reply Nastya_Khovrina !

         

        We've tried with https://api.swaggerhub.com/apis/<user>/<apiname>/<version> and we get a success message in SwaggerHub, but still, nothing happens in Amazon API Gateway. The API is not there.

         

        If there is an error in the integration, Is there any way to check the error message?

         

        Thank you again!