de.mvbonline.tools.restapidoc.model.ApiMethodDoc Maven / Gradle / Ivy

Go to download

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

Creates documentation for a spring mvc RESTful api. Output is reStructuredText for sphinx using sphinxcontrib.httpdomain

The newest version!

package de.mvbonline.tools.restapidoc.model;

import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;

import org.springframework.web.bind.annotation.RequestMethod;

public class ApiMethodDoc {
	private String path;
	private String description;
	private RequestMethod requestMethod;
	private List produces;

    private List consumes;

    private List urlparameters;
	private ApiBodyObjectDoc bodyobject;
	private ApiResponseObjectDoc response;
	private List queryParameters;
	public ApiMethodDoc() {
		super();
		this.urlparameters = new ArrayList();
	    this.queryParameters = new LinkedList();
	}
    public ApiBodyObjectDoc getBodyobject() {
		return bodyobject;
	}

    public List getConsumes() {
		return consumes;
	}

    public String getDescription() {
		return description;
	}

	public String getPath() {
		return path;
	}

	public List getProduces() {
		return produces;
	}

	public List getQueryParameters() {
        return queryParameters;
    }

	public RequestMethod getRequestMethod() {
        return requestMethod;
    }

	public ApiResponseObjectDoc getResponse() {
		return response;
	}

	public List getUrlparameters() {
		return urlparameters;
	}

	public void setBodyobject(ApiBodyObjectDoc bodyobject) {
		this.bodyobject = bodyobject;
	}

	public void setConsumes(List consumes) {
		this.consumes = consumes;
	}

	public void setDescription(String description) {
		this.description = description;
	}

	public void setPath(String path) {
		this.path = path;
	}

	public void setProduces(List produces) {
		this.produces = produces;
	}

	public void setQueryParameters(List queryParameters) {
        this.queryParameters = queryParameters;
    }

	public void setRequestMethod(RequestMethod requestMethod) {
        this.requestMethod = requestMethod;
    }

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

	public void setUrlparameters(List urlparameters) {
		this.urlparameters = urlparameters;
	}
}