A C D E G H I M O P R S T U W

A

accept(String, String) - Method in class org.restdoc.api.MethodDefinition

additionalFields - Variable in class org.restdoc.api.util.RestDocObject

C

createMapper() - Static method in class org.restdoc.api.util.RestDocParser

D

description(String) - Method in class org.restdoc.api.MethodDefinition

description(String) - Method in class org.restdoc.api.RestResource

E

example(ExampleRequest) - Method in class org.restdoc.api.MethodDefinition

ExampleRequest - Class in org.restdoc.api

ExampleRequest() - Constructor for class org.restdoc.api.ExampleRequest

ExampleRequest(String, String) - Constructor for class org.restdoc.api.ExampleRequest

G

getAccepts() - Method in class org.restdoc.api.MethodDefinition

getAdditionalBoolean(String) - Method in class org.restdoc.api.util.RestDocObject

getAdditionalField(String) - Method in class org.restdoc.api.util.RestDocObject

getAdditionalFields() - Method in class org.restdoc.api.util.RestDocObject

getAdditionalNumber(String) - Method in class org.restdoc.api.util.RestDocObject

getAdditionalString(String) - Method in class org.restdoc.api.util.RestDocObject

getBody() - Method in class org.restdoc.api.ExampleRequest

getDescription() - Method in class org.restdoc.api.HeaderDefinition

getDescription() - Method in class org.restdoc.api.MethodDefinition

getDescription() - Method in class org.restdoc.api.ParamDefinition

getDescription() - Method in class org.restdoc.api.RestResource

getExamples() - Method in class org.restdoc.api.MethodDefinition

getHeaders() - Method in class org.restdoc.api.ExampleRequest

getHeaders() - Method in class org.restdoc.api.MethodDefinition

getHeaders() - Method in class org.restdoc.api.ResponseDefinition

getHeaders() - Method in class org.restdoc.api.RestDoc

getId() - Method in class org.restdoc.api.RestResource

getMethods() - Method in class org.restdoc.api.RestResource

getParams() - Method in class org.restdoc.api.RestResource

getPath() - Method in class org.restdoc.api.ExampleRequest

getPath() - Method in class org.restdoc.api.RestResource

getPattern() - Method in class org.restdoc.api.ParamValidation

getRequestHeader() - Method in class org.restdoc.api.GlobalHeader

getResources() - Method in class org.restdoc.api.RestDoc

getResponse() - Method in class org.restdoc.api.MethodDefinition

getResponseHeader() - Method in class org.restdoc.api.GlobalHeader

getSchema() - Method in class org.restdoc.api.Representation

getSchema() - Method in class org.restdoc.api.Schema

getSchemas() - Method in class org.restdoc.api.RestDoc

getStatusCodes() - Method in class org.restdoc.api.MethodDefinition

getType() - Method in class org.restdoc.api.ParamValidation

getType() - Method in class org.restdoc.api.Representation

getType() - Method in class org.restdoc.api.Schema

getTypes() - Method in class org.restdoc.api.ResponseDefinition

getUrl() - Method in class org.restdoc.api.Schema

getValidations() - Method in class org.restdoc.api.ParamDefinition

GlobalHeader - Class in org.restdoc.api

GlobalHeader() - Constructor for class org.restdoc.api.GlobalHeader

H

header(String, String) - Method in class org.restdoc.api.ExampleRequest

header(String, String, boolean) - Method in class org.restdoc.api.MethodDefinition

header(String, String, boolean) - Method in class org.restdoc.api.ResponseDefinition

HeaderDefinition - Class in org.restdoc.api

HeaderDefinition() - Constructor for class org.restdoc.api.HeaderDefinition

HeaderDefinition(String) - Constructor for class org.restdoc.api.HeaderDefinition

HeaderDefinition(String, boolean) - Constructor for class org.restdoc.api.HeaderDefinition

I

id(String) - Method in class org.restdoc.api.RestResource

isRequired() - Method in class org.restdoc.api.HeaderDefinition

M

method(String, MethodDefinition) - Method in class org.restdoc.api.RestResource

MethodDefinition - Class in org.restdoc.api

MethodDefinition() - Constructor for class org.restdoc.api.MethodDefinition

O

org.restdoc.annotations - package org.restdoc.annotations

org.restdoc.api - package org.restdoc.api

org.restdoc.api.util - package org.restdoc.api.util

P

param(String, String, ParamValidation...) - Method in class org.restdoc.api.RestResource

ParamDefinition - Class in org.restdoc.api

ParamDefinition() - Constructor for class org.restdoc.api.ParamDefinition

ParamDefinition(String) - Constructor for class org.restdoc.api.ParamDefinition

ParamValidation - Class in org.restdoc.api

ParamValidation() - Constructor for class org.restdoc.api.ParamValidation

ParamValidation(String, String) - Constructor for class org.restdoc.api.ParamValidation

parseFile(File) - Static method in class org.restdoc.api.util.RestDocParser

parseResource(String) - Static method in class org.restdoc.api.util.RestDocParser

parseString(String) - Static method in class org.restdoc.api.util.RestDocParser

path(String) - Method in class org.restdoc.api.RestResource

R

Representation - Class in org.restdoc.api

Representation() - Constructor for class org.restdoc.api.Representation

Representation(String, String) - Constructor for class org.restdoc.api.Representation

request(String, String, boolean) - Method in class org.restdoc.api.GlobalHeader

response(String, String, boolean) - Method in class org.restdoc.api.GlobalHeader

response(ResponseDefinition) - Method in class org.restdoc.api.MethodDefinition

ResponseDefinition - Class in org.restdoc.api

ResponseDefinition() - Constructor for class org.restdoc.api.ResponseDefinition

RestDoc - Annotation Type in org.restdoc.annotations

RestDoc - Class in org.restdoc.api

RestDoc() - Constructor for class org.restdoc.api.RestDoc

RESTDOC_MEDIATYPE - Static variable in class org.restdoc.api.RestDoc

The RestDoc MediaType application/x-restdoc+json

RestDocAccept - Annotation Type in org.restdoc.annotations

RestDocHeader - Annotation Type in org.restdoc.annotations

RestDocIgnore - Annotation Type in org.restdoc.annotations

RestDocObject - Class in org.restdoc.api.util

RestDocObject() - Constructor for class org.restdoc.api.util.RestDocObject

RestDocParam - Annotation Type in org.restdoc.annotations

RestDocParser - Class in org.restdoc.api.util

RestDocResponse - Annotation Type in org.restdoc.annotations

RestDocReturnCode - Annotation Type in org.restdoc.annotations

RestDocReturnCodes - Annotation Type in org.restdoc.annotations

RestDocSchema - Annotation Type in org.restdoc.annotations

RestDocType - Annotation Type in org.restdoc.annotations

RestDocValidation - Annotation Type in org.restdoc.annotations

RestResource - Class in org.restdoc.api

RestResource() - Constructor for class org.restdoc.api.RestResource

S

Schema - Class in org.restdoc.api

Schema() - Constructor for class org.restdoc.api.Schema

schema(JsonSchema) - Method in class org.restdoc.api.Schema

setAdditionalField(String, Object) - Method in class org.restdoc.api.util.RestDocObject

Add additional field

setBody(String) - Method in class org.restdoc.api.ExampleRequest

setDescription(String) - Method in class org.restdoc.api.HeaderDefinition

setDescription(String) - Method in class org.restdoc.api.MethodDefinition

setDescription(String) - Method in class org.restdoc.api.ParamDefinition

setDescription(String) - Method in class org.restdoc.api.RestResource

setHeaders(GlobalHeader) - Method in class org.restdoc.api.RestDoc

setId(String) - Method in class org.restdoc.api.RestResource

setPath(String) - Method in class org.restdoc.api.ExampleRequest

setPath(String) - Method in class org.restdoc.api.RestResource

setPattern(String) - Method in class org.restdoc.api.ParamValidation

setRequired(boolean) - Method in class org.restdoc.api.HeaderDefinition

setResources(Collection<RestResource>) - Method in class org.restdoc.api.RestDoc

setResponse(ResponseDefinition) - Method in class org.restdoc.api.MethodDefinition

setSchema(String) - Method in class org.restdoc.api.Representation

setSchema(JsonSchema) - Method in class org.restdoc.api.Schema

setSchemas(HashMap<String, Schema>) - Method in class org.restdoc.api.RestDoc

setType(String) - Method in class org.restdoc.api.ParamValidation

setType(String) - Method in class org.restdoc.api.Representation

setType(String) - Method in class org.restdoc.api.Schema

setUrl(String) - Method in class org.restdoc.api.Schema

statusCode(String, String) - Method in class org.restdoc.api.MethodDefinition

T

type(String, String) - Method in class org.restdoc.api.ResponseDefinition

U

url(String) - Method in class org.restdoc.api.Schema

W

writeRestDoc(RestDoc) - Static method in class org.restdoc.api.util.RestDocParser

A C D E G H I M O P R S T U W