Class ServerUrlFilter

java.lang.Object
io.swagger.v3.core.filter.AbstractSpecFilter
org.sdase.commons.server.openapi.filter.ServerUrlFilter
All Implemented Interfaces:
io.swagger.v3.core.filter.OpenAPISpecFilter, jakarta.ws.rs.core.Feature

@Singleton public class ServerUrlFilter extends io.swagger.v3.core.filter.AbstractSpecFilter implements jakarta.ws.rs.core.Feature
An OpenAPISpecFilter that adds the base URL to OpenAPI.servers(List).
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    configure(jakarta.ws.rs.core.FeatureContext context)
     
    Optional<io.swagger.v3.oas.models.OpenAPI>
    filterOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
     

    Methods inherited from class io.swagger.v3.core.filter.AbstractSpecFilter

    filterOperation, filterParameter, filterPathItem, filterRequestBody, filterResponse, filterSchema, filterSchemaProperty, isRemovingUnreferencedDefinitions

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface io.swagger.v3.core.filter.OpenAPISpecFilter

    isOpenAPI31Filter
  • Constructor Details

    • ServerUrlFilter

      public ServerUrlFilter()
  • Method Details

    • filterOpenAPI

      public Optional<io.swagger.v3.oas.models.OpenAPI> filterOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI, Map<String,List<String>> params, Map<String,String> cookies, Map<String,List<String>> headers)
      Specified by:
      filterOpenAPI in interface io.swagger.v3.core.filter.OpenAPISpecFilter
      Overrides:
      filterOpenAPI in class io.swagger.v3.core.filter.AbstractSpecFilter
    • configure

      public boolean configure(jakarta.ws.rs.core.FeatureContext context)
      Specified by:
      configure in interface jakarta.ws.rs.core.Feature