| Package | Description |
|---|---|
| org.jooby.apitool | |
| org.jooby.apitool.raml |
| Modifier and Type | Method and Description |
|---|---|
RouteMethod |
RouteMethod.attribute(String name,
Object value)
Set route attribute.
|
RouteMethod |
RouteMethod.attributes(Map<String,Object> attributes)
Set route attributes.
|
RouteMethod |
RouteMethod.consumes(List<String> consumes)
Set list of consumes media types for this method.
|
RouteMethod |
RouteMethod.description(String description)
Set route description.
|
RouteMethod |
RouteMethod.method(String method)
Change/Set route method.
|
RouteMethod |
RouteMethod.name(String name)
Set route name.
|
RouteMethod |
RouteMethod.param(String name,
Consumer<RouteParameter> customizer)
Find a parameter by name and invoke the given callback.
|
RouteMethod |
RouteMethod.parameters(List<RouteParameter> parameters)
Set all route parameters.
|
RouteMethod |
RouteMethod.pattern(String pattern)
Set HTTP pattern.
|
RouteMethod |
RouteMethod.produces(List<String> produces)
Set list of produces media types for this method.
|
RouteMethod |
RouteMethod.response(RouteResponse response)
Set a route response.
|
RouteMethod |
RouteMethod.summary(String summary)
Set API summary.
|
| Modifier and Type | Method and Description |
|---|---|
List<RouteMethod> |
ApiParser.parse(String application)
Parse application bytecode and build route methods from it.
|
List<RouteMethod> |
ApiParser.parseFully(Jooby application)
Parse application bytecode, build route methods from it and merge output with the given routes.
|
List<RouteMethod> |
ApiParser.parseFully(String application,
List<Route.Definition> routes)
Parse application bytecode, build route methods from it and merge output with the given routes.
|
| Modifier and Type | Method and Description |
|---|---|
ApiTool |
ApiTool.filter(Predicate<RouteMethod> predicate)
Select which route is going to be exported to Swagger/RAML.
|
ApiTool |
ApiTool.modify(Predicate<RouteMethod> matcher,
Consumer<RouteMethod> customizer)
Modify one or more route method who matches the filter.
|
ApiTool |
ApiTool.modify(Predicate<RouteMethod> matcher,
Consumer<RouteMethod> customizer)
Modify one or more route method who matches the filter.
|
ApiParser |
ApiParser.modify(Predicate<RouteMethod> matcher,
Consumer<RouteMethod> customizer)
Modify one or more route method who matches the filter.
|
ApiParser |
ApiParser.modify(Predicate<RouteMethod> matcher,
Consumer<RouteMethod> customizer)
Modify one or more route method who matches the filter.
|
ApiTool.Options |
ApiTool.Options.tagger(Function<RouteMethod,String> tagger)
Set a custom tagger (a.k.a as groupBy operator).
|
| Constructor and Description |
|---|
ApiParser(Path dir,
Predicate<RouteMethod> filter)
Creates a new
ApiParser. |
| Modifier and Type | Method and Description |
|---|---|
static Raml |
Raml.build(Raml base,
List<RouteMethod> routes)
Build a
Raml object from list of RouteMethod. |
Copyright © 2021. All rights reserved.