io.camunda.tasklist.webapp.config.OpenApiConfig Maven / Gradle / Ivy

Go to download
/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH under
 * one or more contributor license agreements. See the NOTICE file distributed
 * with this work for additional information regarding copyright ownership.
 * Licensed under the Camunda License 1.0. You may not use this file
 * except in compliance with the Camunda License 1.0.
 */
package io.camunda.tasklist.webapp.config;

import io.camunda.tasklist.webapp.security.TasklistURIs;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import io.swagger.v3.oas.models.security.SecurityRequirement;
import io.swagger.v3.oas.models.security.SecurityScheme;
import org.springdoc.core.models.GroupedOpenApi;
import org.springdoc.core.properties.SpringDocConfigProperties;
import org.springdoc.core.providers.ObjectMapperProvider;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;

@Configuration
public class OpenApiConfig {

  public static final String COOKIE_SECURITY_SCHEMA_NAME = "cookie";
  public static final SecurityScheme COOKIE_SECURITY_SCHEMA =
      new SecurityScheme()
          .type(SecurityScheme.Type.APIKEY)
          .in(SecurityScheme.In.COOKIE)
          .name(TasklistURIs.COOKIE_JSESSIONID)
          .description("Cookie-based authentication is only available on Self-Managed clusters.");

  public static final String BEARER_SECURITY_SCHEMA_NAME = "bearer-key";
  public static final SecurityScheme BEARER_SECURITY_SCHEMA =
      new SecurityScheme().type(SecurityScheme.Type.HTTP).scheme("bearer").bearerFormat("JWT");

  @Profile({"dev", "preview"})
  @Bean
  public GroupedOpenApi internalApiV1() {
    return versionedInternalApi("v1");
  }

  @Profile({"dev", "preview"})
  @Bean
  public GroupedOpenApi externalApiV1() {
    return versionedExternalApi("v1");
  }

  @Bean
  public GroupedOpenApi publicApiV1() {
    return versionedPublicApi("v1");
  }

  private GroupedOpenApi versionedInternalApi(final String version) {
    return GroupedOpenApi.builder()
        .group("internal-api")
        .addOpenApiCustomizer(
            openApi -> {
              openApi
                  .info(
                      new Info()
                          .title("Tasklist webapp Internal API")
                          .description(
                              "NOTE: For internal use only.
"
                                  + "Please take into account that this is an internal API and it may be subject to changes "
                                  + "in the future without guaranteeing backward compatibility with previous versions.")
                          .contact(new Contact().url("https://www.camunda.com"))
                          .license(
                              new License()
                                  .name("License")
                                  .url("https://docs.camunda.io/docs/reference/licenses/")))
                  .getComponents()
                  .addSecuritySchemes(COOKIE_SECURITY_SCHEMA_NAME, COOKIE_SECURITY_SCHEMA)
                  .addSecuritySchemes(BEARER_SECURITY_SCHEMA_NAME, BEARER_SECURITY_SCHEMA);

              openApi.addSecurityItem(
                  new SecurityRequirement()
                      .addList(COOKIE_SECURITY_SCHEMA_NAME)
                      .addList(BEARER_SECURITY_SCHEMA_NAME));
            })
        .pathsToMatch(String.format("/%s/internal/**", version))
        .build();
  }

  private GroupedOpenApi versionedExternalApi(final String version) {
    return GroupedOpenApi.builder()
        .group("external-api")
        .addOpenApiCustomizer(
            openApi -> {
              openApi
                  .info(
                      new Info()
                          .title("Tasklist webapp External API")
                          .description(
                              "NOTE: For public use.
"
                                  + "This API is exposed publicly but should only be used by internal apps.")
                          .contact(new Contact().url("https://www.camunda.com"))
                          .license(
                              new License()
                                  .name("License")
                                  .url("https://docs.camunda.io/docs/reference/licenses/")))
                  .getComponents()
                  .addSecuritySchemes(COOKIE_SECURITY_SCHEMA_NAME, COOKIE_SECURITY_SCHEMA)
                  .addSecuritySchemes(BEARER_SECURITY_SCHEMA_NAME, BEARER_SECURITY_SCHEMA);

              openApi.addSecurityItem(
                  new SecurityRequirement()
                      .addList(COOKIE_SECURITY_SCHEMA_NAME)
                      .addList(BEARER_SECURITY_SCHEMA_NAME));
            })
        .pathsToMatch(String.format("/%s/external/**", version))
        .build();
  }

  private GroupedOpenApi versionedPublicApi(final String version) {
    return GroupedOpenApi.builder()
        .group(version)
        .addOpenApiCustomizer(
            openApi -> {
              openApi
                  .info(
                      new Info()
                          .title("Tasklist REST API")
                          .description(
                              "Tasklist is a ready-to-use API application to rapidly implement business processes alongside user tasks in Zeebe.")
                          .version("v1")
                          .contact(new Contact().url("https://www.camunda.com"))
                          .license(
                              new License()
                                  .name("License")
                                  .url("https://docs.camunda.io/docs/reference/licenses/")))
                  .getComponents()
                  .addSecuritySchemes(COOKIE_SECURITY_SCHEMA_NAME, COOKIE_SECURITY_SCHEMA)
                  .addSecuritySchemes(BEARER_SECURITY_SCHEMA_NAME, BEARER_SECURITY_SCHEMA);

              openApi.addSecurityItem(
                  new SecurityRequirement()
                      .addList(COOKIE_SECURITY_SCHEMA_NAME)
                      .addList(BEARER_SECURITY_SCHEMA_NAME));
            })
        .pathsToMatch(String.format("/%s/**", version))
        .pathsToExclude(
            String.format("/%s/internal/**", version), String.format("/%s/external/**", version))
        .build();
  }

  /**
   * This bean is declared explicitly in order to resolve {@code BeanDefinitionOverrideException}
   * Spring exception because of the bean with the same name configured by GraphQL dependency:
   * {@link
   * graphql.kickstart.autoconfigure.web.servlet.GraphQLWebAutoConfiguration#objectMapperProvider}
   */
  @Bean("springdocObjectMapperProvider")
  public ObjectMapperProvider objectMapperProvider(
      SpringDocConfigProperties springDocConfigProperties) {
    return new ObjectMapperProvider(springDocConfigProperties);
  }
}