Swagger – Pauls Blog https://sterl.org Fri, 06 Oct 2023 19:19:58 +0000 de hourly 1 https://wordpress.org/?v=6.8.3 Useful links for Event Driven Architectures https://sterl.org/2023/10/useful-links-for-event-driven-architectures/ https://sterl.org/2023/10/useful-links-for-event-driven-architectures/#comments Thu, 05 Oct 2023 09:29:20 +0000 https://sterl.org/?p=965
  • https://cloudevents.io/
  • https://www.eventcatalog.dev/
  • https://www.asyncapi.com/
  • https://github.com/confluentinc/schema-registry
    • ]]>     https://sterl.org/2023/10/useful-links-for-event-driven-architectures/feed/ 1     Spring Boot Redirect to SwaggerUI https://sterl.org/2021/05/spring-boot-redirect-to-swaggerui/ https://sterl.org/2021/05/spring-boot-redirect-to-swaggerui/#respond Fri, 21 May 2021 13:13:33 +0000 https://sterl.org/?p=650 Problem

    Some services don’t have an UI and the OpenAPI/ Swagger UI should be used as default UI of the service. As so the root should be redirected directly to the SwaggerUI.

    Solution

    Just add a WebMvc redirect.

    @Configuration
public class OpenApiConfig implements WebMvcConfigurer {
  @Override
  public void addViewControllers(final ViewControllerRegistry registry) {
    registry.addRedirectViewController("/", "/swagger-ui.html");
    // use setStatusCode(HttpStatus.XYZ) for any custom status code if required, e.g. MOVED_PERMANENTLY
    registry.addRedirectViewController("/swagger-ui", "/swagger-ui.html");
    // any other alias
  }
}

    Swagger Open API dependencies

    Spring Boot 2.x

    Ensure you check the current version: 

            <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-ui</artifactId>
            <version>1.7.0</version>
        </dependency>
       <!-- if spring security is used -->
        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-security</artifactId>
            <version>1.7.0</version>
        </dependency>

    Spring Boot 3.x

    Ensure you check the current version:

            <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
            <version>2.1.0</version>
        </dependency>

    With the new version you can also use the application.yml to configure the root directory as swagger ui:

    springdoc:
  swagger-ui:
    use-root-path: true

    Links

    ]]>     https://sterl.org/2021/05/spring-boot-redirect-to-swaggerui/feed/ 0     Spring Boot RestTemplate no SSL check https://sterl.org/2019/06/spring-boot-resttemplate-no-ssl-check/ https://sterl.org/2019/06/spring-boot-resttemplate-no-ssl-check/#respond Sun, 16 Jun 2019 18:56:00 +0000 https://sterl.org/?p=662 Problem

    By default the Spring RestTempalte and the swagger OpenAPI client does an SSL check. This is usually not required on the test system, as so the goal is to remove the SSL check from the Spring Boot Rest Template.

    Remote host closed connection during handshake; nested exception is javax.net.ssl.SSLHandshakeException: Remote host closed connection during handshake

    RestTemplate

    @Bean
public RestTemplate restTemplate() throws KeyManagementException, NoSuchAlgorithmException, KeyStoreException {
    final RestTemplate restTemplate = new RestTemplate(sslFactory());
    return restTemplate;
}

@Bean
public HttpComponentsClientHttpRequestFactory sslFactory() throws KeyManagementException, NoSuchAlgorithmException, KeyStoreException {
    final TrustStrategy acceptingTrustStrategy = (X509Certificate[] chain, String authType) -> true;

    final SSLContext sslContext = org.apache.http.ssl.SSLContexts.custom()
                    .loadTrustMaterial(null, acceptingTrustStrategy)
                    .build();

    final SSLConnectionSocketFactory csf = new SSLConnectionSocketFactory(sslContext);

    final CloseableHttpClient httpClient = HttpClients.custom()
                    .setMaxConnPerRoute(250)
                    .setMaxConnTotal(250)
                    .setSSLSocketFactory(csf)
                    // during the SSL check we have also the verification of the host name,
                    // this can be skipped to like this:
                    .setSSLHostnameVerifier(NoopHostnameVerifier.INSTANCE)
                    .build();

    final HttpComponentsClientHttpRequestFactory requestFactory =
                    new HttpComponentsClientHttpRequestFactory();

    requestFactory.setHttpClient(httpClient);

    return requestFactory;
}

    Apache HTTP Client pom.xml

    <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
</dependency>

    Swagger OpenAPI Client

    Furthermore sometimes it is required to remove the SSL check from the OpenAPI Swagger ApiClient.

    Use the Spring RestTemplate for Swagger Client

    Add the following flag: -Dio.swagger.parser.util.RemoteUrl.trustAll=true 

    Configure Swagger Client

    // If a using spring rest template assign here the RestTemplate
final XyzApi result = new XyzApi(new ApiClient(restTemplate));
    <plugin>
    <groupId>org.openapitools</groupId>
    <artifactId>openapi-generator-maven-plugin</artifactId>
    <executions>
        <execution>
            <id>xyz-client</id>
          <goals>
            <goal>generate</goal>
          </goals>
          <configuration>
          	    <!-- use Spring RestTemaplte, optional -->
                <library>resttemplate</library>
	            <!-- skip SSL check -->
                <environmentVariables>
                    <io.swagger.parser.util.RemoteUrl.trustAll>true</io.swagger.parser.util.RemoteUrl.trustAll>
                </environmentVariables>

    Links

    • https://pragmaticintegrator.wordpress.com/2017/08/13/small-hack-to-avoid-ssl-validation-in-spring-resttemplate/
    • http://progressivecoder.com/avoid-ssl-validation-spring-boot-resttemplate/
    • https://dev.to/mnpaa/disable-skip-ssl-validation-in-springboot-resttemplate-1ec2
    • https://github.com/swagger-api/swagger-codegen/wiki/FAQ#is-there-a-way-to-disable-certificate-verification

    ]]>     https://sterl.org/2019/06/spring-boot-resttemplate-no-ssl-check/feed/ 0