Skip to content

Commit b74d0bc

Browse files
committed
docs: add docs
I've copied the description from https://testcontainers.com/modules/mockserve/
1 parent 9e38f90 commit b74d0bc

File tree

3 files changed

+18
-0
lines changed

3 files changed

+18
-0
lines changed

docs/modules/mockserver.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Mockserver Module
2+
3+
[MockServer](https://www.mock-server.com/#what-is-mockserver) allows you to mock any server or service via HTTP or HTTPS, such as a REST or RPC service.
4+
5+
## Install
6+
7+
```bash
8+
npm install @testcontainers/mockserver --save-dev
9+
```
10+
11+
## Examples
12+
13+
<!--codeinclude-->
14+
[Start container:](../../packages/modules/mockserver/src/mockserver-container.test.ts) inside_block:startContainer
15+
<!--/codeinclude-->

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ nav:
5454
- Kafka: modules/kafka.md
5555
- Localstack: modules/localstack.md
5656
- MariaDB: modules/mariadb.md
57+
- Mockserver: modules/mockserver.md
5758
- MongoDB: modules/mongodb.md
5859
- MSSQLServer: modules/mssqlserver.md
5960
- MySQL: modules/mysql.md

packages/modules/mockserver/src/mockserver-container.test.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import { MockserverContainer } from "./mockserver-container";
55
describe.only("MockserverContainer", () => {
66
jest.setTimeout(240_000);
77

8+
// startContainer {
89
it("should start and accept mocks", async () => {
910
const container = await new MockserverContainer().start();
1011
const client = mockServerClient(container.getHost(), container.getMockserverPort());
@@ -28,4 +29,5 @@ describe.only("MockserverContainer", () => {
2829
expect(response.statusCode).toBe(200);
2930
expect(response.text).toBe("bar");
3031
});
32+
// }
3133
});

0 commit comments

Comments
 (0)