Fix documentation for programmatic RouterFunctions

[johnellinwood]

Edit: This is just a documentation fix. On the main springdoc page for the programmatic openapi feature, you should point out that the route() method in your example is not the normal route() method from functional spring webflux routing. Looking more closely at the example code and javadocs, I see you have a [SpringdocRouteBuilder.route()](https://javadoc.io/static/org.springdoc/springdoc-openapi-webflux-core/1.6.6/org/springdoc/webflux/core/fn/SpringdocRouteBuilder.html#route()) that is completely different than the normal spring RouterFunctions.route() method that people are used to calling.

The fact these are different methods isn't mentioned in your documentation, and since you do a static import in the example code, it was really easy to miss.

Original:

Describe the bug You can't create a RouterFunction with programmatic openapi details

@Bean RouterFunction<ServerResponse> myroute() {
  return route().GET("/foo", HANDLER_FUNCTION, ops -> ops.operationId("hello")).build()
}

like the documentation says here.

To Reproduce Steps to reproduce the behavior:

• SpringBoot 2.7.4
• Spring WebFlux 5.3.23
• SpringDoc 1.6.11
• Using springdoc-openapi-common, springdoc-openapi-webflux-core, springdoc-openapi-webflux-ui
• Expecting the application to compile and generate openapi document
• It doesn't compile because there is no method signature in RouterFunction.Builder for GET() that takes that combination of parameters.

Expected behavior

• This spring commit shows the expected behavior that should compile
• The expected result is to compile and generate any openapi output at all

Additional context

• SpringDoc's web site shows this example should work: https://springdoc.org/features.html#_spring_webfluxwebmvc_fn_with_functional_endpoints
• SpringDoc examples also use it: https://github.com/springdoc/springdoc-openapi/blob/master/springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app90/quotes/QuotesRouter.java#L56
• The latest documentation for spring RouterFunctions.builder doesn't show that method signature: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/reactive/function/server/RouterFunctions.Builder.html

[johnellinwood]

To further clarify this. I'm just trying to add openapi details programmatically. I currently have annotations on my RouterFunctions and HandlerFunctions. But a lot of these are exactly the same except for operationId and return types, so I'm trying to create some generic functions to apply the openapi information to them. To do this, I need to use the programmatic openapi interface. The only way I can see to do this is with the org.springdoc.core.fn.builders.apiresponse.Builder api and somehow attach it to the RouterFunction. But i don't see any way to do that, since the methods in the examples don't exist in the latest spring webflux.

[johnellinwood]

Hey, so I think this is a documentation issue. On the main springdoc page for the programmatic openapi feature, you should point out that the route() method in your example is not the normal route() method from functional spring webflux routing. Looking more closely at the example code and javadocs, I see you have a [SpringdocRouteBuilder.route()](https://javadoc.io/static/org.springdoc/springdoc-openapi-webflux-core/1.6.6/org/springdoc/webflux/core/fn/SpringdocRouteBuilder.html#route()) that is completely different than the normal spring RouterFunctions.route() method that people are used to calling.

The fact these are different methods isn't mentioned in your documentation, and since you do a static import in the example code, it was really easy to miss.

[bnasslahsen]

@johnellinwood,

If you have bugs in the documentation, please feel free to update directly the related .adoc files.

[bnasslahsen]

closed as no activity