Skip to content

Add configurable subpath for HTTP API #427

Open
@stevekinney

Description

@stevekinney

The change made in #410 causes a few potential problems for integrating with the UI.

First, some users host UI Server at a subpath and set both the client-side and API routes.

route.SetAPIRoutes(e, cfgProvider, serverOpts.APIMiddleware)
route.SetUIRoutes(e, cfg.PublicPath, assets)

Secondly, not having a sub-path for the API routes means that they will likely conflict with client-side UI routes. The current implementation of the UI passes through all routes with /api/v1 to UI Server. If both the pages and the API routes have the same path, it will be trickier to correctly implement the passthrough functionality.

Suggested resolutions:

  • The path for the API routes should be configurable.
  • They should default to something (e.g. /api) and not be set at the root by default since—selfishly—we'd need this set for CLI, Docker, and Temporal Cloud implementations anyway.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions