cn.mapway.document.module.Entry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api-tools-doc Show documentation

auto gen doc from api with ui

There is a newer version: 3.20.0

package cn.mapway.document.module;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

// TODO: Auto-generated Javadoc

/**
 * 接口信息.
 *
 * @author zhangjianshe
 */
public class Entry implements Serializable {

    /**
     * Instantiates a new entry.
     */
    public Entry() {
    }

    /**
     * 入口的函数名称.
     */
    public String methodName;

    /**
     * 接口名称.
     */
    public String title;

    /**
     * 接口说明.
     */
    public String summary = "";

    /**
     * 接口相对路径.
     */
    public String relativePath = "";

    /**
     * 接口路径.
     */
    public String url = "";

    /**
     * 调用类型.
     */
    public List invokeMethods = new ArrayList();

    /**
     * 输入参数.
     */
    public List input = new ArrayList();
    /**
     * 输入参数.
     */
    public List pathParas = new ArrayList();
    /**
     * 输入参数.
     */
    public List queryParas = new ArrayList();

    /**
     * 输出参数.
     */
    public ObjectInfo output;

    /**
     * 接口的排序值.
     */
    public int order;

    /**
     * 接口创建者.
     */
    public String author;

    /**
     * 方法所在的类.
     */
    public String parentClassName;

    /**
     * 开发状态.
     */
    public String state;

    /**
     * API 显示样式.
     */
    public String apiStyle;

    /**
     * 文档的标签列表
     */
    public List tags = new ArrayList();
}