webapi

Class Raml10

java.lang.Object

webapi.Raml10

public class Raml10
extends java.lang.Object

Provides methods for RAML 1.0 processing

Constructor Summary

Constructors

Constructor and Description
Raml10()

Method Summary

Modifier and Type	Method and Description
static java.util.concurrent.CompletableFuture<scala.runtime.BoxedUnit>	generateFile(WebApiBaseUnit model, java.lang.String url) Generates file with RAML 1.0 content.
static java.util.concurrent.CompletableFuture<java.lang.String>	generateString(WebApiBaseUnit model) Generates string with RAML 1.0 content.
static java.util.concurrent.CompletableFuture<WebApiBaseUnit>	parse(java.lang.String urlOrContent) Parses RAML 1.0 content from string or url.
static java.util.concurrent.CompletableFuture<WebApiBaseUnit>	parse(java.lang.String content, java.lang.String baseUrl) Parses RAML 1.0 content from string with a custom API Doc location.
static java.util.concurrent.CompletableFuture<WebApiBaseUnit>	resolve(WebApiBaseUnit model) Resolves parsed RAML 1.0 model.
static java.util.concurrent.CompletableFuture<amf.client.validate.ValidationReport>	validate(WebApiBaseUnit model) Validates parsed RAML 1.0 model.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Raml10

public Raml10()

Method Detail

parse

public static java.util.concurrent.CompletableFuture<WebApiBaseUnit> parse(java.lang.String urlOrContent)

Parses RAML 1.0 content from string or url.

Parameters:

urlOrContent - File url/path or content string to be parsed.

Returns:

Parsed WebApi Model (future).

parse

public static java.util.concurrent.CompletableFuture<WebApiBaseUnit> parse(java.lang.String content,
                                                                           java.lang.String baseUrl)

Parses RAML 1.0 content from string with a custom API Doc location.

Parameters:

content - Content string to be parsed.

baseUrl - Location to assign to a doc parsed from a content string. References are resolved relative to this location.

Returns:

Parsed WebApi Model (future).

generateFile

public static java.util.concurrent.CompletableFuture<scala.runtime.BoxedUnit> generateFile(WebApiBaseUnit model,
                                                                                           java.lang.String url)

Generates file with RAML 1.0 content.

Parameters:

model - Parsed WebApi Model to generate content from.

url - Path to the generated file.

Returns:

(undocumented)

generateString

public static java.util.concurrent.CompletableFuture<java.lang.String> generateString(WebApiBaseUnit model)

Generates string with RAML 1.0 content.

Parameters:

model - Parsed WebApi Model to generate content from.

Returns:

Generated string (future).

validate

public static java.util.concurrent.CompletableFuture<amf.client.validate.ValidationReport> validate(WebApiBaseUnit model)

Validates parsed RAML 1.0 model.

Parameters:

model - Parsed WebApi Model to be validated.

Returns:

Validation report (future).

resolve

public static java.util.concurrent.CompletableFuture<WebApiBaseUnit> resolve(WebApiBaseUnit model)

Resolves parsed RAML 1.0 model.

Resolution process includes resolving references to all types, libraries, etc.

Parameters:

model - Parsed WebApi Model to be resolved.

Returns:

Resolved parsed WebApi Model (future).