org.jsondoc.spring.boot.starter.JSONDocProperties Maven / Gradle / Ivy

Go to download

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

The newest version!

package org.jsondoc.spring.boot.starter;

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

import org.jsondoc.core.pojo.JSONDoc.MethodDisplay;
import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = JSONDocConfig.JSONDOC_PROPERTIES_PREFIX)
public class JSONDocProperties {

	/**
	 * The version of your API.
	 */
	private String version;

	/**
	 * The base path of your API, for example http://localhost:8080.
	 */
	private String basePath;

	/**
	 * The list of packages that JSONDoc will scan to look for annotated classes
	 * to be documented.
	 */
	private List packages = new ArrayList();

	/**
	 * Whether the playground should be enabled in the UI or not. Defaults to
	 * true.
	 */
	private boolean playgroundEnabled = true;

	/**
	 * Whether to display methods as URIs or with a short description (summary attribute in the @ApiMethod annotation).
	 * Allowed values are URI and SUMMARY.
	 */
	private MethodDisplay displayMethodAs = MethodDisplay.URI;

	public String getVersion() {
		return version;
	}

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

	public String getBasePath() {
		return basePath;
	}

	public void setBasePath(String basePath) {
		this.basePath = basePath;
	}

	public List getPackages() {
		return packages;
	}

	public void setPackages(List packages) {
		this.packages = packages;
	}

	public boolean isPlaygroundEnabled() {
		return playgroundEnabled;
	}

	public void setPlaygroundEnabled(boolean playgroundEnabled) {
		this.playgroundEnabled = playgroundEnabled;
	}

	public MethodDisplay getDisplayMethodAs() {
		return displayMethodAs;
	}

	public void setDisplayMethodAs(MethodDisplay displayMethodAs) {
		this.displayMethodAs = displayMethodAs;
	}

}