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

Swagger route locator

Open
#173 4 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

Suppose we have some of end points in some micro service...end point 1 to end point 5. But only end point 2 and 4 should be exposed externally.

Would it make sense to implement a predicate which uses some swagger definition to determine if the route should be applied? In this example the swagger would expose only the paths associated with end point 2 and 4.

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 by reviewing how route predicates are defined and applied in Spring Cloud Gateway, then examine how a Swagger or OpenAPI definition could identify externally exposed paths. Done would mean a decided and documented approach for exposing only the paths represented by the API definition, but the issue does not name files or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, spring, spring-boot
Domain
api, backend
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.