Skip to content

Commit 509281f

Browse files
servers: document imports (#1531)
1 parent c74fc29 commit 509281f

9 files changed

Lines changed: 32 additions & 1 deletion

File tree

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<dependency>
2+
<groupId>org.testingisdocumenting.webtau</groupId>
3+
<artifactId>webtau-server</artifactId>
4+
<version>${project.version}</version>
5+
</dependency>
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* Doc: [servers import](servers/import-and-dependencies)

webtau-docs/znai/servers/fake-server.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,14 @@ Groovy:
88
title: "fake server creation example",
99
surroundedBy: "router-example"
1010
}
11+
:include-markdown: import-ref.md
1112
1213
Java:
1314
:include-file: com/example/tests/junit5/FakeServerJavaTest.java {
1415
title: "fake server creation example",
1516
surroundedBy: "router-example"
1617
}
18+
:include-markdown: import-ref.md
1719
```
1820

1921
# Fake Server Creation
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:include-markdown: imports/single-dsl-import.md
2+
3+
# Server Specific Import
4+
5+
To only import `server` module use
6+
7+
```tabs
8+
Groovy:
9+
:include-file: com/example/tests/junit5/FakeServerJavaTest.java {title: "server import", include: "WebTauServerFacade.server", replace: [";", ""]}
10+
:include-file: maven/server-dep.xml {title: "maven dependency"}
11+
12+
Java:
13+
:include-file: com/example/tests/junit5/FakeServerJavaTest.java {title: "server import", include: "WebTauServerFacade.server"}
14+
:include-file: maven/server-dep.xml {title: "maven dependency"}
15+
```
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Check [Import And Dependencies](servers/import-and-dependencies) for prerequisites.

webtau-docs/znai/servers/server-router.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,14 @@ Groovy:
1212
title: "router creation example",
1313
surroundedBy: "router-example"
1414
}
15+
:include-markdown: import-ref.md
1516
1617
Java:
1718
:include-file: com/example/tests/junit5/FakeServerJavaTest.java {
1819
title: "router creation example",
1920
surroundedBy: "router-example"
2021
}
22+
:include-markdown: import-ref.md
2123
```
2224

2325
# Request Properties {style: "api"}

webtau-docs/znai/servers/static-server.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,14 @@ Groovy:
99
title: "create and start server",
1010
surroundedBy: "static-server-create",
1111
}
12+
:include-markdown: import-ref.md
1213
1314
Java:
1415
:include-file: com/example/tests/junit5/StaticServerJavaTest.java {
1516
title: "create and start server",
1617
surroundedBy: "static-server-create"
1718
}
19+
:include-markdown: import-ref.md
1820
```
1921

2022
:include-file: data/staticcontent/data.json {autoTitle: true}

webtau-docs/znai/toc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ servers
5555
proxy-server
5656
fake-server
5757
server-router
58+
import-and-dependencies
5859
cli
5960
introduction
6061
foreground-command

webtau-junit5-examples/src/test/java/com/example/tests/junit5/FakeServerJavaTest.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@
2424

2525
import java.util.regex.Pattern;
2626

27-
import static org.testingisdocumenting.webtau.WebTauDsl.*;
27+
import static org.testingisdocumenting.webtau.WebTauCore.*;
28+
import static org.testingisdocumenting.webtau.http.Http.*;
29+
import static org.testingisdocumenting.webtau.server.WebTauServerFacade.server;
2830

2931
public class FakeServerJavaTest {
3032
private static WebTauServer myServer;

0 commit comments

Comments
 (0)