Package ch.admin.bit.jeap.swagger

Class SwaggerProperties

java.lang.Object
ch.admin.bit.jeap.swagger.SwaggerProperties
@AutoConfiguration @PropertySource("classpath:SwaggerDefaultConfiguration.properties") @ConfigurationProperties(prefix="jeap.swagger") public class SwaggerProperties extends Object
Configurations for Swagger in Blueprint Microservice

  • Constructor Details

    • SwaggerProperties

      public SwaggerProperties()

  • Method Details

    • getOauth

      public ch.admin.bit.jeap.swagger.SwaggerProperties.Oauth getOauth()

    • getSecured

      public ch.admin.bit.jeap.swagger.SwaggerProperties.Secured getSecured()

    • getStatus

      @NonNull public @NonNull SwaggerProperties.SwaggerStatus getStatus()
      The status of swagger in the project: * SwaggerProperties.SwaggerStatus.OPEN swagger can be accessed without authentication, * SwaggerProperties.SwaggerStatus.SECURED swagger can only be accessed with basic auth, * SwaggerProperties.SwaggerStatus.DISABLED swagger cannot be accessed * SwaggerProperties.SwaggerStatus.CUSTOM no spring security configuration at all Default is DISABLED, but you can set it to OPEN for local environments

    • getAntPathPatters

      @NonNull public @NonNull List<String> getAntPathPatters()
      Ant-Patters which paths are part of swagger ui. Usually you do not need to change this

    • isEnforceServerBaseHttps

      public boolean isEnforceServerBaseHttps()
      When set to true, Server definitions delivered to Swagger Frontend will have https as protocol instead of http. This is useful for architectures where the microservice listens to http and is behind a load balancer or reverse proxy configured to listen to https

    • setOauth

      public void setOauth(ch.admin.bit.jeap.swagger.SwaggerProperties.Oauth oauth)

    • setSecured

      public void setSecured(ch.admin.bit.jeap.swagger.SwaggerProperties.Secured secured)

    • setStatus

      public void setStatus(@NonNull @NonNull SwaggerProperties.SwaggerStatus status)
      The status of swagger in the project: * SwaggerProperties.SwaggerStatus.OPEN swagger can be accessed without authentication, * SwaggerProperties.SwaggerStatus.SECURED swagger can only be accessed with basic auth, * SwaggerProperties.SwaggerStatus.DISABLED swagger cannot be accessed * SwaggerProperties.SwaggerStatus.CUSTOM no spring security configuration at all Default is DISABLED, but you can set it to OPEN for local environments

    • setAntPathPatters

      public void setAntPathPatters(@NonNull @NonNull List<String> antPathPatters)
      Ant-Patters which paths are part of swagger ui. Usually you do not need to change this

    • setEnforceServerBaseHttps

      public void setEnforceServerBaseHttps(boolean enforceServerBaseHttps)
      When set to true, Server definitions delivered to Swagger Frontend will have https as protocol instead of http. This is useful for architectures where the microservice listens to http and is behind a load balancer or reverse proxy configured to listen to https

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object