com.tencent.devops.common.web.JerseySwaggerConfig.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common-web Show documentation
Tencent blueking ci project
There is a newer version: 3.1.0-rc.4
/*
 * Tencent is pleased to support the open source community by making BK-CI 蓝鲸持续集成平台 available.
 *
 * Copyright (C) 2019 THL A29 Limited, a Tencent company.  All rights reserved.
 *
 * BK-CI 蓝鲸持续集成平台 is licensed under the MIT license.
 *
 * A copy of the MIT License is included in this file.
 *
 *
 * Terms of the MIT License:
 * ---------------------------------------------------
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
 * the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 * LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
 * NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package com.tencent.devops.common.web

import io.swagger.v3.oas.integration.SwaggerConfiguration
import io.swagger.v3.oas.models.OpenAPI
import io.swagger.v3.oas.models.info.Info
import io.swagger.v3.oas.models.servers.Server
import javax.annotation.PostConstruct
import org.slf4j.LoggerFactory
import org.springframework.beans.factory.annotation.Value

class JerseySwaggerConfig : JerseyConfig() {

    @Value("\${spring.application.desc:#{null}}")
    private val applicationDesc: String? = null

    @Value("\${spring.application.version:#{null}}")
    private val applicationVersion: String? = null

    @Value("\${spring.application.packageName:#{null}}")
    private val packageName: String? = null

    @Value("\${spring.application.name:#{null}}")
    private val service: String? = null

    @Value("\${swagger.append.name:#{null}}")
    private val swaggerAppendName: String? = null

    private val logger = LoggerFactory.getLogger(JerseySwaggerConfig::class.java)

    @PostConstruct
    fun init() {
        logger.info("[$service|$applicationDesc|$applicationVersion|$swaggerAppendName|$packageName]configSwagger")
        val swaggerResource = SwaggerResource()
        swaggerResource.openApiConfiguration(configSwagger())
        register(swaggerResource)
    }

    private fun configSwagger(): SwaggerConfiguration? {
        if (!packageName.isNullOrBlank()) {
            return if (swaggerAppendName == "true") {
                SwaggerConfiguration().apply {
                    openAPI = OpenAPI()
                        .info(Info().title(applicationDesc).version(applicationVersion))
                        .addServersItem(Server().url("/$service"))
                    resourcePackages = setOf(packageName)
                    scannerClass = "com.tencent.devops.common.web.swagger.BkJaxrsAnnotationScanner"
                }
            } else {
                SwaggerConfiguration().apply {
                    openAPI = OpenAPI()
                        .info(Info().title(applicationDesc).version(applicationVersion))
                        .addServersItem(Server().url("/"))
                    resourcePackages = setOf(packageName)
                    scannerClass = "com.tencent.devops.common.web.swagger.BkJaxrsAnnotationScanner"
                }
            }
        }
        return null
    }
}