com.github.xiaoymin.swaggerbootstrapui.plugin.OperationOrderBuilderPlugin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swagger-bootstrap-ui Show documentation

Swagger-Bootstrap-UI is the front of the UI Swagger implementation, using jQuery+bootstrap implementation, the purpose is to replace the default UI Swagger implementation of the Swagger-UI, so that the document is more friendly...

The newest version!

/*
 * Copyright (C) 2018 Zhejiang xiaominfo Technology CO.,LTD.
 * All rights reserved.
 * Official Web Site: http://www.xiaominfo.com.
 * Developer Web Site: http://open.xiaominfo.com.
 */

package com.github.xiaoymin.swaggerbootstrapui.plugin;

import com.google.common.base.Optional;
import com.google.common.collect.Lists;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiOperationSort;
import io.swagger.annotations.ApiOperationSupport;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import springfox.documentation.service.StringVendorExtension;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.OperationContext;

/***
 *
 * @since:swagger-bootstrap-ui 1.9.4
 * @author [email protected] 
 * 2019/06/06 19:59
 */
@Component
@Order(Ordered.HIGHEST_PRECEDENCE+100)
public class OperationOrderBuilderPlugin extends AbstractOperationBuilderPlugin {

    /**
     * 扩展接口的排序规则,添加排序扩展字段
     * {@link io.swagger.annotations.ApiOperationSupport} field order
     * {@link io.swagger.annotations.ApiOperationSort} field value
     * {@link io.swagger.annotations.ApiOperation} field position
     * ApiOperation - ApiOperationSort - ApioperationSupport
     * @param context 操作上下文
     */
    @Override
    public void apply(OperationContext context) {
        int position;
        //首先查找ApiOperation注解
        Optional api=context.findAnnotation(ApiOperation.class);
        if (api.isPresent()){
            //判断postion是否有值
            int posit=api.get().position();
            if (posit!=0){
                position=posit;
            }else{
                position=findPosition(context);
            }
        }else{
            position=findPosition(context);
        }
        context.operationBuilder().extensions(Lists.newArrayList(new StringVendorExtension("x-order",String.valueOf(position))));
    }

    @Override
    public boolean supports(DocumentationType delimiter) {
        return true;
    }


    private int findPosition(OperationContext context){
        int position=Integer.MAX_VALUE;
        Optional apiOperationSortOptional=context.findAnnotation(ApiOperationSort.class);
        if (apiOperationSortOptional.isPresent()){
            position=apiOperationSortOptional.get().value();
        }else{
            Optional apso=context.findAnnotation(ApiOperationSupport.class);
            if (apso.isPresent()){
                //判断值
                if (apso.get().order()!=0){
                    position=apso.get().order();
                }
            }
        }
        return position;
    }
}