CORS Proxy

When debugging endpoints on a published doc site, users might run into CORS (Cross-origin Resource Sharing) issues caused by browser security restrictions. To fix this, you can set up a CORS proxy for the site. This ensures that all endpoint requests from the doc site are routed through a designated Request Proxy Agent.

Here are the proxy options available, depending on your needs:

Cloud Agent: This uses Apidog'sCloud Agentto handle endpoint requests from the shared documentation. Keep in mind that the Cloud Agent cannot access endpoints on internal network.

Browser Extensions: This option uses a browser extension installed in the user's browser to handle requests. If the user hasn't installed the extension, they'll be prompted to do so before initiating any endpoint requests.

No Proxy: Selecting this option means that requests will be directly sent from the user's browser to the endpoint. Ensure the endpoint server settings are configured correctly to handle CORS, preventing potential issues.

Self-hosted Request Proxy Agent: This allows you to use a Self-hosted Request Proxy Agent deployed within your team to handle endpoint requests from the shared documentation.

How to Choose a Proxy Type?

Public API/Endpoints: Prioritize using Cloud Agent.

Internal API/Endpoints:

Simple scenarios: Use Browser Extension.

High-security requirements: Use Self-Hosted Request Proxy Agent.

FAQ

Why can't the browser extension carry Cookies?

Browser security policies block extensions from modifying reserved headers like Cookie (full list). To carry Cookies in requests, use the Cloud Agent or Apidog Desktop Client.

Learn more

Request proxy in Apidog web

Request proxy in shared docs

Request proxy in Apidog client

How to Choose a Proxy Type?#

FAQ#

Learn more#

How to Choose a Proxy Type?

FAQ

Learn more