Package org.apache.cxf.jaxrs.swagger.ui

Class SwaggerUiService

java.lang.Object

org.apache.cxf.jaxrs.swagger.ui.SwaggerUiService

@Path("api-docs")
public class SwaggerUiService
extends Object

Constructor Summary

Constructors

Constructor	Description
SwaggerUiService(SwaggerUiResourceLocator locator, Map<String,String> mediaTypes)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getResource(jakarta.ws.rs.core.UriInfo uriInfo, String resourcePath)
protected String	replaceUrl(String index, String replacement)	Replaces the URL inside Swagger UI index.html file.
void	setConfig(SwaggerUiConfig config)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SwaggerUiService

public SwaggerUiService(SwaggerUiResourceLocator locator,
 Map<String,String> mediaTypes)

Method Details

setConfig

public void setConfig(SwaggerUiConfig config)

getResource

@GET
@Path("{resource:.*}")
public jakarta.ws.rs.core.Response getResource(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @PathParam("resource")
 String resourcePath)

replaceUrl

protected String replaceUrl(String index,
 String replacement)

Replaces the URL inside Swagger UI index.html file. The implementation does not attempt to read the file and parse it as valid HTML but uses straightforward approach by looking for the URL pattern of the SwaggerUIBundle initialization and replacing it.

Parameters:

index - index.html file content

replacement - replacement URL

Returns:

index.html file content with replaced URL