com.github.ydoc.core.strategy.Strategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ydoc-spring-boot-starter Show documentation

YDoc一款低侵入性、简洁并同时支持SwaggerUi和YApi的文档生成器

The newest version!

package com.github.ydoc.core.strategy;

import com.alibaba.fastjson.JSONObject;
import com.github.ydoc.core.kv.DocApi;
import com.github.ydoc.core.kv.Kv;

import java.util.List;

/**
 * @author yujian 顶层接口
 **/
public interface Strategy {
    /**
     * 核心生成方法入口
     *
     * @param api api
     */
    void generateApi(O api);

    /**
     * 公共返回处理
     * 
     * @param docApi  doc
     * @param content content
     */
    void baseResponse(DocApi docApi, Kv content);

    /**
     * 公共参数处理
     * 
     * @param docApi      doc
     * @param queryParams params
     */
    void baseRequest(DocApi docApi, List queryParams);

}