spring-cloud / spring-cloud/spring-cloud-gateway

Provide human readable title and description for specific route configurations

Open
#1,242 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
4.9k
Forks
3.5k
Avg merge
20h 57m
Merged PRs (30d)
8

Description

As a Developer I want to know what APIs are available through our API Gateway so that I can leverage them to provide solutions for customer problems

Today there is an actuator endpoint at /actuator/gateway/routes that provides a JSON response with all routes configured on the Gateway. The properties that are included in this response are specific to the route configuration. This enhancement would be to add properties at the top level for each route to provide human readable information to potential consumers of each API route. Here are my suggestions for these properties:

  • title - human readable name for the route (goes alongside current property route_id)
  • description - one to two paragraphs that describe the intended use case for the route
  • documentation - and array of links to more documentation and examples of using that API

Contributor guide

Open the contributing guide

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

Start from the /actuator/gateway/routes endpoint and the route configuration model that supplies its response. Determine where route-level metadata can be represented and exposed, then verify that each route can return title, description, and documentation links alongside route_id. Add or update tests for the endpoint response and its configured metadata.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring, spring-boot
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.