Skip to content

Commit 414e56c

Browse files
jknackjknack
committed
v1.5.0
1 parent 6ae71b4 commit 414e56c

File tree

181 files changed

+634
-385
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

181 files changed

+634
-385
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.jooby/jooby/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.jooby/jooby)
2-
[![javadoc](https://javadoc.io/badge/org.jooby/jooby.svg)](https://javadoc.io/doc/org.jooby/jooby/1.4.1)
2+
[![javadoc](https://javadoc.io/badge/org.jooby/jooby.svg)](https://javadoc.io/doc/org.jooby/jooby/1.5.0)
33
[![Become a Patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://patreon.com/edgarespina)
44
[![Build Status](https://travis-ci.org/jooby-project/jooby.svg?branch=master)](https://travis-ci.org/jooby-project/jooby)
55
[![coveralls.io](https://img.shields.io/coveralls/jooby-project/jooby.svg)](https://coveralls.io/r/jooby-project/jooby?branch=master)

‎jooby/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<parent>
77
<groupId>org.jooby</groupId>
88
<artifactId>jooby-project</artifactId>
9-
<version>1.4.2-SNAPSHOT</version>
9+
<version>1.5.0</version>
1010
</parent>
1111

1212
<modelVersion>4.0.0</modelVersion>

‎modules/coverage-report/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<parent>
66
<groupId>org.jooby</groupId>
77
<artifactId>modules</artifactId>
8-
<version>1.4.2-SNAPSHOT</version>
8+
<version>1.5.0</version>
99
</parent>
1010

1111
<modelVersion>4.0.0</modelVersion>

‎modules/jooby-akka/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.jooby/jooby-akka/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.jooby/jooby-akka)
2-
[![javadoc](https://javadoc.io/badge/org.jooby/jooby-akka.svg)](https://javadoc.io/doc/org.jooby/jooby-akka/1.4.1)
2+
[![javadoc](https://javadoc.io/badge/org.jooby/jooby-akka.svg)](https://javadoc.io/doc/org.jooby/jooby-akka/1.5.0)
33
[![jooby-akka website](https://img.shields.io/badge/jooby-akka-brightgreen.svg)](http://jooby.org/doc/akka)
44
# akka
55

@@ -15,7 +15,7 @@ Small module to build concurrent & distributed applications via [Akka](http://ak
1515
<dependency>
1616
<groupId>org.jooby</groupId>
1717
<artifactId>jooby-akka</artifactId>
18-
<version>1.4.1</version>
18+
<version>1.5.0</version>
1919
</dependency>
2020
```
2121

‎modules/jooby-akka/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<parent>
66
<groupId>org.jooby</groupId>
77
<artifactId>modules</artifactId>
8-
<version>1.4.2-SNAPSHOT</version>
8+
<version>1.5.0</version>
99
</parent>
1010

1111
<modelVersion>4.0.0</modelVersion>

‎modules/jooby-apitool/README.md‎

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.jooby/jooby-apitool/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.jooby/jooby-apitool)
2-
[![javadoc](https://javadoc.io/badge/org.jooby/jooby-apitool.svg)](https://javadoc.io/doc/org.jooby/jooby-apitool/1.4.1)
2+
[![javadoc](https://javadoc.io/badge/org.jooby/jooby-apitool.svg)](https://javadoc.io/doc/org.jooby/jooby-apitool/1.5.0)
33
[![jooby-apitool website](https://img.shields.io/badge/jooby-apitool-brightgreen.svg)](http://jooby.org/doc/apitool)
44
# API tool
55

6-
Automatically export your HTTP API to open standards like <a href="https://swagger.io/">Swagger</a> and <a href="https://raml.org/">RAML</a>.
6+
API reference generator for <a href="https://swagger.io/">Swagger</a> and <a href="https://raml.org/">RAML</a>.
77

8-
This module generates live documentation from your HTTP API.
8+
This module generates live documentation from your HTTP API (source code).
99

1010
## screenshots
1111

@@ -23,7 +23,7 @@ This module generates live documentation from your HTTP API.
2323
<dependency>
2424
<groupId>org.jooby</groupId>
2525
<artifactId>jooby-apitool</artifactId>
26-
<version>1.4.1</version>
26+
<version>1.5.0</version>
2727
</dependency>
2828
```
2929

@@ -38,7 +38,7 @@ This module generates live documentation from your HTTP API.
3838
}
3939
```
4040

41-
Those lines export your API to <a href="https://swagger.io/">Swagger</a> and <a href="https://raml.org/">RAML</a>.
41+
Those lines export your API to <a href="https://swagger.io/">Swagger</a>, <a href="https://raml.org/">RAML</a> or <a href="http://rebilly.github.io/ReDoc/">ReDoc</a>.
4242

4343
## example
4444

@@ -130,6 +130,30 @@ The [ApiTool](/apidocs/org/jooby/apitool/ApiTool.html) module automatically expo
130130

131131
Works for ```MVC routes``` and <a href="http://jooby.org/doc/lang-kotlin">Kotlin</a>.
132132

133+
## redoc
134+
135+
[ReDoc](http://rebilly.github.io/ReDoc/) example:
136+
137+
```java
138+
{
139+
use(new ApiTool()
140+
.redoc()
141+
)
142+
}
143+
```
144+
145+
Or if you want to keep Swagger UI and ReDoc:
146+
147+
```java
148+
{
149+
use(new ApiTool()
150+
.swagger(new Options("/swagger")
151+
.redoc()
152+
)
153+
)
154+
}
155+
```
156+
133157
## keep documentation
134158

135159
The [ApiTool](/apidocs/org/jooby/apitool/ApiTool.html) module parses documentation from source code. It works well as long as the source code is present, but it won't work after you deploy your application.
@@ -163,7 +187,7 @@ Go to ```build.gradle``` and add these lines:
163187
```gradke
164188
buildscript {
165189
dependencies {
166-
classpath group: 'org.jooby', name: 'jooby-gradle-plugin', version: '1.4.1'
190+
classpath group: 'org.jooby', name: 'jooby-gradle-plugin', version: '1.5.0'
167191
}
168192
}
169193
apply plugin: 'jooby'

‎modules/jooby-apitool/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<parent>
77
<groupId>org.jooby</groupId>
88
<artifactId>modules</artifactId>
9-
<version>1.4.2-SNAPSHOT</version>
9+
<version>1.5.0</version>
1010
</parent>
1111

1212
<modelVersion>4.0.0</modelVersion>

‎modules/jooby-apitool/src/main/java/org/jooby/apitool/ApiTool.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -865,6 +865,7 @@ public ApiTool redoc() {
865865
/**
866866
* Mount ReDoc at <code>/redoc</code>
867867
*
868+
* @param path Redoc path.
868869
* @return This option.
869870
*/
870871
public ApiTool redoc(String path) {
@@ -916,6 +917,7 @@ public ApiTool swagger(Options options) {
916917
* Mount Swagger using the given options.
917918
*
918919
* @param options Swagger options.
920+
* @param swagger Customizer.
919921
* @return This tool.
920922
*/
921923
public ApiTool swagger(Options options, Consumer<Swagger> swagger) {

‎modules/jooby-apitool/src/main/java/org/jooby/apitool/RouteMethod.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -339,8 +339,7 @@ public RouteMethod parameters(List<RouteParameter> parameters) {
339339
}
340340

341341
/**
342-
* API summary. This is usually the javadoc of {@link org.jooby.Router#use(String)} method or the
343-
* javadoc of a class for MVC routes.
342+
* API summary.
344343
*
345344
* @return Summary or empty.
346345
*/

‎modules/jooby-archetype/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<parent>
88
<groupId>org.jooby</groupId>
99
<artifactId>modules</artifactId>
10-
<version>1.4.2-SNAPSHOT</version>
10+
<version>1.5.0</version>
1111
</parent>
1212

1313
<artifactId>jooby-archetype</artifactId>

0 commit comments

Comments
 (0)