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.0.0
/*
 * 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.jaxrs.config.BeanConfig
import io.swagger.jaxrs.listing.SwaggerSerializers
import org.slf4j.LoggerFactory
import org.springframework.beans.factory.annotation.Value
import javax.annotation.PostConstruct

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")
        configSwagger()
        register(SwaggerSerializers::class.java)
        register(SwaggerResource::class.java)
    }

    private fun configSwagger() {
        if (packageName != null && packageName.isNotBlank()) {
            if (swaggerAppendName == "true") {
                BeanConfig().apply {
                    title = applicationDesc
                    version = applicationVersion
                    resourcePackage = packageName
                    scan = true
                    basePath = "/$service/api"
                }
            } else {
                BeanConfig().apply {
                    title = applicationDesc
                    version = applicationVersion
                    resourcePackage = packageName
                    scan = true
                    basePath = "/api"
                }
            }
        }
    }
}