io.camunda.operate.webapp.rest.SwaggerConfig 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.operate.webapp.rest;

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 org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;

@Profile("dev")
@Configuration
public class SwaggerConfig {
  @Bean
  public GroupedOpenApi internalAPI() {
    return GroupedOpenApi.builder()
        .group("internal-api")
        .addOpenApiCustomizer(openApi -> openApi.info(getInternalAPIInfo()))
        .pathsToMatch("/api/*")
        .build();
  }

  private Info getInternalAPIInfo() {
    return new Info()
        .title("Operate Internal API")
        .description("For internal use only.")
        .contact(new Contact().url("https://www.camunda.com"))
        .license(
            new License().name("License").url("https://docs.camunda.io/docs/reference/licenses/"));
  }
}