NatLabRockies / NatLabRockies/api-umbrella

Flexible frontend prefix matching without using 'matching order' field?

Open
#342 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
2.2k
Forks
373
PR merge metrics
No merged PRs in 30d

Description

We allow end-users, of the Apinf platform, to add API Umbrella API backends, including defining a custom frontend prefix. This has led to some problems, such as the following frontend prefixes resolving to the wrong API Backend:

Intended:

  • /music - initial frontend prefix added by user
    • Intended -> resolves to 'Music API: root'
    • Actual: works as expected
  • /music/alternative/ - second frontend prefix added by user
    • Intended -> resolves to 'Music API: Alternative
    • Actual: respoves to 'Music API: root'

We are noticing that API Umbrella uses a global matching order field to mitigate this issue. However, in our current UI, a global 'matching order' might not make sense to a user who has just added one or more APIs, but who may not be responsible for the remaining APIs.

What are some ideas as to how we might allow end-users to add APIs, so that calls resolve in an intuitive/expected way?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by reviewing how frontend prefixes and the global matching order currently resolve requests, then define a user-facing resolution model that avoids requiring unrelated APIs to be ordered; done means the expected behavior and scope are agreed.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.