org.raml.v2.api.model.v10.api

Interface Api

All Superinterfaces:

Annotable, LibraryBase

public interface Api
extends LibraryBase

Method Summary

Methods

Modifier and Type	Method and Description
FullUriTemplateString	baseUri() A URI that's to be used as the base of all the resources' URIs.
List<TypeDeclaration>	baseUriParameters() Named parameters used in the baseUri (template)
List<DocumentationItem>	documentation() Additional overall documentation for the API
List<MimeType>	mediaType() The default media type to use for request and response bodies (payloads), e.g.
List<String>	protocols() The protocols supported by the API
String	ramlVersion() Returns RAML version.
List<Resource>	resources() The resources of the API, identified as relative URIs that begin with a slash (/).
List<SecuritySchemeRef>	securedBy() The security schemes that apply to every resource and method in the API
String	title() Short plain-text label for the API
String	version() The version of the API, e.g.

Methods inherited from interface org.raml.v2.api.model.v10.api.LibraryBase

annotationTypes, resourceTypes, schemas, securitySchemes, traits, types

Methods inherited from interface org.raml.v2.api.model.v10.common.Annotable

annotations

Method Detail

title

String title()

Short plain-text label for the API

version

String version()

The version of the API, e.g. 'v1'

baseUri

FullUriTemplateString baseUri()

A URI that's to be used as the base of all the resources' URIs. Often used as the base of the URL of each resource, containing the location of the API. Can be a template URI.

baseUriParameters

List<TypeDeclaration> baseUriParameters()

Named parameters used in the baseUri (template)

protocols

List<String> protocols()

The protocols supported by the API

mediaType

List<MimeType> mediaType()

The default media type to use for request and response bodies (payloads), e.g. "application/json"

securedBy

List<SecuritySchemeRef> securedBy()

The security schemes that apply to every resource and method in the API

resources

List<Resource> resources()

The resources of the API, identified as relative URIs that begin with a slash (/). Every property whose key begins with a slash (/), and is either at the root of the API definition or is the child property of a resource property, is a resource property, e.g.: /users, /{groupId}, etc

documentation

List<DocumentationItem> documentation()

Additional overall documentation for the API

ramlVersion

String ramlVersion()

Returns RAML version. "RAML10" string is returned for RAML 1.0. "RAML08" string is returned for RAML 0.8.