search

jbretsch / openapi-route-definition-locator

A RouteDefinitionLocator for Spring Cloud Gateway which creates route definitions dynamically based on OpenAPI (aka Swagger) definitions served by backend (micro)services.
MIT License
16 stars 5 forks source link

Allow pull requests #11

Open PaulContremoulin opened 7 months ago

PaulContremoulin commented 7 months ago

Hi,

Can we suggest new additionnals fonctionnalities by submitting Pull Requests ? Any convention should be respected ?

I would like to add new capabilities like:

Thanks

jbretsch commented 6 months ago

Hi Paul,

sorry for the late response. Somehow this issue didn't catch my eye.

I welcome suggestions for additional functionalities and pull requests. I suggest, however, that you don't just submit a pull request immediately. You can, of course, do as you please. But to save you unnecessary implementation work, how about the following?

  1. You create enhancement issues first.
  2. Roughly describe your solution (immediately or later via comments): How will the configuration for this new feature look like? How will library users access the new feature? (Answers to those questions are required for changes to the README.md in the pull request anyhow.) Rough implementation ideas if the feature is more involved.
  3. Discuss if necessary.
  4. Create a pull request.

Any convention should be respected?

I didn't bother with explicitly defining conventions as there wasn't a need, yet. Just make the new code nicely blend in with the existing one.

The first one of your enhancement ideas crossed my mind already. But I haven't thought long enough yet about how to let this work nicely with Spring Cloud Gateway's out-of-the-box auto-discovery feature.

The second one also sounds interesting. There might be connections with https://github.com/jbretsch/openapi-route-definition-locator/issues/6.

Best regards, Jan