com.duoec.doc.doclet.pojo.Api Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of duo-doclet-pojo Show documentation
duo-doclet base pojo
The newest version!
package com.duoec.doc.doclet.pojo;

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

/**
 * @author xuwenzhen
 */
public class Api implements Serializable, Comparable {
    private static final long serialVersionUID = 1L;
    /**
     * API编码，即{className}.{methodName}
     */
    private String code;

    /**
     * API编码，全局唯一
     */
    private String key;

    /**
     * 接口类型：0=RestFul, 1=Dubbo
     *
     * @see com.duoec.doc.doclet.enums.ApiTypeEnum
     */
    private Integer type;

    /**
     * 接口名称
     */
    private String name;

    /**
     * 接口版本
     */
    private String version;

    /**
     * 注释
     */
    private String comment;

    /**
     * since注释
     */
    private String since;

    /**
     * author注释
     */
    private String author;

    /**
     * deprecated 注释
     */
    private String deprecated;

    /**
     * 链接
     */
    private List links;

    /**
     * 参数注解，比如@PathVariable / @RequestBody等
     */
    private List annotations;

    /**
     * 响应
     */
    private EntityRef response;

    /**
     * 请求参数
     */
    private List requestParams;

    /**
     * 排序值，越小越前
     */
    private Integer order;

    /**
     * 代码归属人
     */
    private CodeBlame blame;

    /**
     * 是否不允许mock
     */
    private Boolean noMock;

    /**
     * 是否不允许调用
     */
    private Boolean noInvoke;

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }

    public String getKey() {
        return key;
    }

    public void setKey(String key) {
        this.key = key;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }

    public String getComment() {
        return comment;
    }

    public void setComment(String comment) {
        this.comment = comment;
    }

    public String getSince() {
        return since;
    }

    public void setSince(String since) {
        this.since = since;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }

    public String getDeprecated() {
        return deprecated;
    }

    public void setDeprecated(String deprecated) {
        this.deprecated = deprecated;
    }

    public EntityRef getResponse() {
        return response;
    }

    public void setResponse(EntityRef response) {
        this.response = response;
    }

    public List getRequestParams() {
        return requestParams;
    }

    public void setRequestParams(List requestParams) {
        this.requestParams = requestParams;
    }

    public Integer getType() {
        return type;
    }

    public void setType(Integer type) {
        this.type = type;
    }

    public Integer getOrder() {
        return order;
    }

    public void setOrder(Integer order) {
        this.order = order;
    }

    public List getLinks() {
        return links;
    }

    public void setLinks(List links) {
        this.links = links;
    }

    public List getAnnotations() {
        return annotations;
    }

    public void setAnnotations(List annotations) {
        this.annotations = annotations;
    }

    @Override
    public int compareTo(Api o) {
        return this.order - o.order;
    }

    public CodeBlame getBlame() {
        return blame;
    }

    public void setBlame(CodeBlame blame) {
        this.blame = blame;
    }

    public Boolean getNoMock() {
        return noMock;
    }

    public void setNoMock(Boolean noMock) {
        this.noMock = noMock;
    }

    public Boolean getNoInvoke() {
        return noInvoke;
    }

    public void setNoInvoke(Boolean noInvoke) {
        this.noInvoke = noInvoke;
    }
}