org.jooby.raml

Class Raml

java.lang.Object

org.jooby.raml.Raml

Deprecated.

@Deprecated
public class Raml
extends Object

raml

RESTful API Modeling Language (RAML) makes it easy to manage the whole API lifecycle from design to sharing. It's concise - you only write what you need to define - and reusable. It is machine readable API design that is actually human friendly. More at http://raml.org

NOTE: This modules depends on RouteSpec, please read the RouteSpec to learn how to use this tool.

usage

 {
   // define your API... via script or MVC:
   / * *
      * Everything about your pets
      */
    use("/api/pets")
       / * *
         * Get a pet by ID.
         * @param id Pet ID
         */
      .get("/:id", req  -> {
        int id = req.param("id").intValue();
        DB db = req.require(DB.class);
        Pet pet = db.find(Pet.class, id);
        return pet;
      })
      ...;

   new Raml().install(this);
 }
 

You also need the jooby:spec maven plugin:

 <plugin>
   <groupId>org.jooby</groupId>
   <artifactId>jooby-maven-plugin</artifactId>
   <executions>
     <execution>
       <goals>
         <goal>spec</goal>
       </goals>
     </execution>
   </executions>
 </plugin>
 

The plugin compiles the API and produces a .spec file for prod environments.

The RAML api-console will be available at /raml and the .raml will be at: /raml/api.raml

options

There are a few options available, let's see what they are:

path

The path option controls where to mount the RAML routes:

 {
   ...
   new Raml("docs").install(this);
 }
 

Produces: /docs for api-console and /docs/api.raml. Default path is: /raml.

filter

The filter option controls what is exported to RAML:

 {
   ...
   new Raml()
     .filter(route  -> {
       return route.pattern().startsWith("/api");
     })
     .install(this);
 }
 

Default filter keeps /api/* routes.

noConsole

This option turn off the api-console:

 {
   ...
   new Raml()
     .noConsole()
     .install(this);
 }
 

theme

Set the ui-theme for api-console. Available options are light and dark. Default is: light.

 {
   ...
   new Raml()
     .theme("dark")
     .install(this);
 }
 

clientGenerator

Shows/hide the client generator button from api-console.

tryIt

Expand/collapse the try it panel from api-console.

Since:

0.15.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
Raml() Deprecated. Creates a new Raml under the /raml path.
Raml(String path) Deprecated. Creates a new Raml.

Method Summary

Modifier and Type	Method and Description
Raml	clientGenerator(boolean enabled) Deprecated. Shows/hide client generator button for api-console.
Raml	filter(Predicate<RouteSpec> filter) Deprecated. Apply a route filter.
void	install(org.jooby.Jooby app) Deprecated. Install Raml in the given app.
Raml	noConsole() Deprecated. Turn off api-console.
Raml	theme(String theme) Deprecated. Set a ui-theme for api-console.
Raml	tryIt(boolean enabled) Deprecated. Expand/collapse the try-it panel for api-console.

Methods inherited from class java.lang.Object

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

Constructor Detail

Raml

public Raml(String path)

Deprecated.

Creates a new Raml.

Parameters:

path - A raml path.

Raml

public Raml()

Deprecated.

Creates a new Raml under the /raml path.

Method Detail

filter

public Raml filter(Predicate<RouteSpec> filter)

Deprecated.

Apply a route filter. By default only routes at /api will be exported.

Parameters:

filter - A route filter.

Returns:

This instance.

theme

public Raml theme(String theme)

Deprecated.

Set a ui-theme for api-console.

Parameters:

theme - Dark or light. Default is light.

Returns:

This instance.

clientGenerator

public Raml clientGenerator(boolean enabled)

Deprecated.

Shows/hide client generator button for api-console.

Parameters:

enabled - True shows the button.

Returns:

This instance.

tryIt

public Raml tryIt(boolean enabled)

Deprecated.

Expand/collapse the try-it panel for api-console.

Parameters:

enabled - True expands the panel.

Returns:

This instance.

noConsole

public Raml noConsole()

Deprecated.

Turn off api-console.

Returns:

This instance.

install

public void install(org.jooby.Jooby app)

Deprecated.

Install Raml in the given app.

Parameters:

app - An application.