Package org.sdase.commons.server.openapi.filter

Class ServerUrlFilter

  • All Implemented Interfaces:
    io.swagger.v3.core.filter.OpenAPISpecFilter, javax.ws.rs.core.Feature
    @Singleton
public class ServerUrlFilter
extends io.swagger.v3.core.filter.AbstractSpecFilter
implements javax.ws.rs.core.Feature
    An OpenAPISpecFilter that adds the base URL to OpenAPI.servers(List).

    • Constructor Summary

      Constructors 
      Constructor Description
      ServerUrlFilter()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean configure​(javax.ws.rs.core.FeatureContext context)  
      java.util.Optional<io.swagger.v3.oas.models.OpenAPI> filterOpenAPI​(io.swagger.v3.oas.models.OpenAPI openAPI, java.util.Map<java.lang.String,​java.util.List<java.lang.String>> params, java.util.Map<java.lang.String,​java.lang.String> cookies, java.util.Map<java.lang.String,​java.util.List<java.lang.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 Detail

      • ServerUrlFilter

        public ServerUrlFilter()

    • Method Detail

      • filterOpenAPI

        public java.util.Optional<io.swagger.v3.oas.models.OpenAPI> filterOpenAPI​(io.swagger.v3.oas.models.OpenAPI openAPI,
                                                                          java.util.Map<java.lang.String,​java.util.List<java.lang.String>> params,
                                                                          java.util.Map<java.lang.String,​java.lang.String> cookies,
                                                                          java.util.Map<java.lang.String,​java.util.List<java.lang.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​(javax.ws.rs.core.FeatureContext context)
        Specified by:
        configure in interface javax.ws.rs.core.Feature