com.github.xiaoymin.knife4j.spring.extension.Knife4jJakartaOperationCustomizer Maven / Gradle / Ivy
/*
* Copyright © 2017-2023 Knife4j([email protected])
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.github.xiaoymin.knife4j.spring.extension;
import com.github.xiaoymin.knife4j.annotations.ApiOperationSupport;
import com.github.xiaoymin.knife4j.annotations.ApiSupport;
import com.github.xiaoymin.knife4j.core.conf.ExtensionsConstants;
import com.github.xiaoymin.knife4j.core.util.StrUtil;
import com.github.xiaoymin.knife4j.extend.util.ExtensionUtils;
import io.swagger.v3.oas.models.Operation;
import lombok.extern.slf4j.Slf4j;
import org.springdoc.core.customizers.GlobalOperationCustomizer;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.web.method.HandlerMethod;
/**
* @author [email protected]
* 2023/2/26 12:14
* @since knife4j
*/
@Slf4j
public class Knife4jJakartaOperationCustomizer implements GlobalOperationCustomizer {
@Override
public Operation customize(Operation operation, HandlerMethod handlerMethod) {
// 解析支持作者、接口排序
// https://gitee.com/xiaoym/knife4j/issues/I6FB9I
ApiOperationSupport operationSupport = AnnotationUtils.findAnnotation(handlerMethod.getMethod(), ApiOperationSupport.class);
if (operationSupport != null) {
String author = ExtensionUtils.getAuthors(operationSupport);
if (StrUtil.isNotBlank(author)) {
operation.addExtension(ExtensionsConstants.EXTENSION_AUTHOR, author);
}
if (operationSupport.order() != 0) {
operation.addExtension(ExtensionsConstants.EXTENSION_ORDER, operationSupport.order());
}
} else {
// 如果方法级别不存在，再找一次class级别的
ApiSupport apiSupport = AnnotationUtils.findAnnotation(handlerMethod.getBeanType(), ApiSupport.class);
if (apiSupport != null) {
String author = ExtensionUtils.getAuthor(apiSupport);
if (StrUtil.isNotBlank(author)) {
operation.addExtension(ExtensionsConstants.EXTENSION_AUTHOR, author);
}
if (apiSupport.order() != 0) {
operation.addExtension(ExtensionsConstants.EXTENSION_ORDER, apiSupport.order());
}
}
}
return operation;
}
}