forked from wiremock/wiremock.org
-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
303 lines (290 loc) · 11.8 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
site_name: WireMock Documentation
site_description: >-
WireMock Documentation.
# FIXME: replace by production file
site_url: https://oleg-nenashev.github.io/wiremock.org/docs
site_2x_url: https://oleg-nenashev.github.io/wiremock.org/2.x
copyright: Copyright © 2023 - WireMock Contributors
docs_dir: _docs
repo_url: https://github.com/wiremock/wiremock.org
repo_name: WireMock Docs on GitHub
edit_uri: edit/main/_docs/
# Build
site_dir: _site-docs
# Theme
theme:
name: material
custom_dir: _docs_theme
highlightjs: true
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.code.select
- content.tabs.link
- content.tooltips
# - header.autohide
# - navigation.expand
- navigation.footer
# NOT compatible qith toc.integrate
# - navigation.indexes
- navigation.path
# - navigation.instant
# - navigation.instant.prefetch
# - navigation.instant.progress
# - navigation.prune
- navigation.sections
- navigation.expand
- navigation.tabs
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
font:
text: DM Sans
code: Roboto Mono
favicon: assets/images/favicon.svg
logo: images/logos/wiremock/logo_wide.svg
icon:
repo: fontawesome/brands/github
extra:
versions:
wiremock_version: "3.3.1"
wiremock_docker_image: "3.3.1-1"
wiremock_baseline: "3.x"
grpc_extension_version: 0.4.0
social:
- icon: fontawesome/brands/slack
link: community/slack.md
name: WireMock Community Slack
- icon: fontawesome/brands/twitter
link: https://twitter.com/wiremockorg
name: WireMock on Twitter
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/wiremock/
name: WireMock on LinkedIn
- icon: fontawesome/brands/mastodon
link: https://fosstodon.org/@wiremock
name: WireMock on Fosstodon
analytics:
provider: google
# FIXME: Update when in Production
property: G-QSLQ4RWTRP
plugins:
- extra-sass
- search
- autorefs
- macros
- render_swagger
# OpenGraphs
- social:
# custom_layouts_dir is commercial feature
- multirepo:
# TODO: Change to True once works
cleanup: false
keep_docs_dir: true
nav_repos:
- name: graphql-extension
import_url: 'https://github.com/wiremock/wiremock-graphql-extension?branch=main&edit_uri=/blob/main/'
imports: [ /README.md, docs/* ]
- name: grpc-extension
import_url: 'https://github.com/wiremock/wiremock-grpc-extension?branch=main&edit_uri=/blob/main/'
imports: [ /README.md, docs/* ]
- name: state-extension
import_url: 'https://github.com/wiremock/wiremock-state-extension?branch=develop&edit_uri=/blob/develop/'
imports: [ /README.md, docs/* ]
- name: otel-extension
import_url: 'https://github.com/wiremock/wiremock-otel-extension?branch=main&edit_uri=/blob/main/'
imports: [ /README.md ]
- name: faker-extension
import_url: 'https://github.com/wiremock/wiremock-faker-extension?branch=main&edit_uri=/blob/main/'
imports: [ /README.md ]
# Outside WireMock GitHub org
- name: 9cookies-extension
import_url: 'https://github.com/9cookies/wiremock-extensions?branch=master&edit_uri=/blob/master/'
imports: [ /*.md ]
- name: jwt-extension
import_url: 'https://github.com/MasonM/wiremock-jwt-extension?branch=master&edit_uri=/blob/master/'
imports: [ /README.md ]
- name: cors-extension
import_url: 'https://github.com/RichieLoco/WiremockCorsExtension?branch=master&edit_uri=/blob/master/'
imports: [ /README.md ]
- name: stub-mapping-tracker-extension
import_url: 'https://github.com/MasonM/wiremock-stub-mapping-tracker?branch=master&edit_uri=/blob/master/'
imports: [ /README.md ]
- name: prometheus-extension
import_url: 'https://github.com/mikeskali/wiremock-metrics?branch=master&edit_uri=/blob/master/'
imports: [ /README.md ]
- name: record-delay-extension
import_url: 'https://github.com/anuragashok/wiremock-extension-record-delay?branch=main&edit_uri=/blob/main/'
imports: [ /README.md ]
- name: velocity-transformer-extension
import_url: 'https://github.com/adamyork/wiremock-velocity-transformer?branch=master&edit_uri=/blob/master/'
imports: [ /README.md ]
- name: unused-stubs-extension
import_url: 'https://github.com/MasonM/wiremock-unused-stubs-extension?branch=master&edit_uri=/blob/master/'
imports: [ /README.md ]
- name: metrics-extension
import_url: 'https://github.com/rasklaad/wiremock-metrics?branch=master&edit_uri=/blob/master/'
imports: [ /README.MD ]
# System
- name: community
import_url: 'https://github.com/wiremock/community?branch=main&edit_uri=/blob/main/'
imports: [ "*" ]
- name: dotgithub
import_url: 'https://github.com/wiremock/.github?branch=main&edit_uri=/blob/main/'
imports: [ CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md ]
- redirects:
redirect_maps:
'android.md': 'solutions/android.md'
'go.md': 'solutions/golang.md'
'solutions/go.md': 'solutions/golang.md'
'graphql.md': 'solutions/graphql.md'
'testcontainers.md': 'solutions/testcontainers.md'
'spring-boot.md': 'solutions/spring-boot.md'
'api.md': 'standalone/admin-api-reference.md'
'download.md': 'download-and-installation.md'
'tutorials.md': 'getting-started.md'
'plain-java.md': 'java-usage.md'
'junit-rule.md': 'junit-extensions.md'
'junit-4.md': 'junit-extensions.md'
'junit-5.md': 'junit-jupiter.md'
'docker.md': 'standalone/docker.md'
'solutions/docker.md': 'standalone/docker.md'
'running-standalone.md': 'standalone/java-jar.md'
'support.md': '../support'
'solutions.md': "README.md"
nav:
- Using WireMock:
- Getting started:
- Overview: overview.md
- "Quick Start: API Mocking with Java and JUnit 4": quickstart/java-junit.md
- Download and Installation: download-and-installation.md
- WireMock Tutorials: getting-started.md
- FAQ: faq.md
- WireMock Standalone:
- Running in Docker: standalone/docker.md
- Running as a Standalone Process: standalone/java-jar.md
- Administrating WireMock: standalone/administration.md
- Admin REST API Specification: standalone/admin-api-reference.md
- Java Usage:
- JUnit 5+ Jupiter: junit-jupiter.md
- JUnit 4 and Vintage: junit-extensions.md
- Spring Boot: solutions/spring-boot.md
- Plain Java: java-usage.md
- Java configuration: configuration.md
- Running without the HTTP Server: running-without-http-server.md
- Stubbing & Verifying:
- Stubbing: stubbing.md
- Request Matching: request-matching.md
- Response Templating: response-templating.md
- Simulating Faults: simulating-faults.md
- Stateful Behaviour: stateful-behaviour.md
- Proxying: proxying.md
- Verifying: verifying.md
- Templating:
- WireMock API Templates Library: mock-api-templates/README.md
- Using Mock API Templates: mock-api-templates/usage.md
- Record & Playback:
- Record and Playback: record-playback.md
- Protocols:
- Supported Protocols: protocols/README.md
- Webhooks and Callbacks: webhooks-and-callbacks.md
- Mocking gRPC services: grpc.md
- WireMock and GraphQL: solutions/graphql.md
- Serving HTTPs: https.md
- Advanced use-cases:
- Multi-domain Mocking: multi-domain-mocking.md
- Deploying into a servlet container: advanced/deploy-to-servlet-container.md
- "WireMock on Java 1.7": advanced/java7.md
- Reference:
- Admin API: standalone/admin-api-reference.md
- Security: dotgithub/SECURITY.md
- WireMock API Templates Library: mock-api-templates/README.md
- Extensions:
- WireMock Extensions: extensions/README.md
- Features:
- gRPC: grpc-extension/README.md
- GraphQL: graphql-extension/README.md
- State: state-extension/README.md
- Response Template Transformer: response-templating.md
- Velocity Response Transformer: velocity-transformer-extension/README.md
- Data Faker: faker-extension/README.md
- Webhooks: webhooks-and-callbacks.md
- CORS protection: cors-extension/README.md
- JSON Web Tokens (JWT): jwt-extension/README.md
- JSON Body Transformer: 9cookies-extension/json-body-transformer.md
- Request Time Matcher: 9cookies-extension/request-time-matcher.md
- Unused Stubs: unused-stubs-extension/README.md
- Operations Extensions:
- Metrics Extension: metrics-extension/README.MD
- Prometheus Metrics: prometheus-extension/README.md
- OpenTelemetry: otel-extension/README.md
- Developer Extensions:
- Callback Simulator: 9cookies-extension/callback-simulator.md
- Keywords: 9cookies-extension/keywords.md
- Stub Mapping Tracker: stub-mapping-tracker-extension/README.md
- Record Delay Capture: record-delay-extension/README.md
- Integrations:
- WireMock Solution Pages: solutions/README.md
- Java and JVM Languages: solutions/jvm.md
- gRPC: grpc.md
- GraphQL: solutions/graphql.md
- Python: solutions/python.md
- Node.js: solutions/nodejs.md
- .NET: solutions/dotnet.md
- Golang: solutions/golang.md
- Rust: solutions/rust.md
- Kubernetes: solutions/kubernetes.md
- Testcontainers: solutions/testcontainers.md
- C/C++: solutions/c_cpp.md
- Developer Guide:
- Extending WireMock: extending-wiremock.md
- Filtering and Modifying Requests: extensibility/filtering-requests.md
- Transforming Responses: extensibility/transforming-responses.md
- Custom Matching: extensibility/custom-matching.md
- Listening for Serve Events: extensibility/listening-for-serve-events.md
- Admin API Extensions: extensibility/extending-the-admin-api.md
- Adding Template Helpers: extensibility/adding-template-helpers.md
- Adding Template Model Data: extensibility/adding-template-model-data.md
- Listening for Stub Changes: extensibility/listening-for-stub-changes.md
- Listening for Settings Changes: extensibility/listening-for-settings-changes.md
- Mappings Loader Extensions: extensibility/adding-mappings-loader.md
- Stub Metadata: stub-metadata.md
- Community:
- Participate in WireMock: participate.md
- Community Slack: community/slack.md
- Contributor Guide: community/contributing/README.md
- Hacktoberfest 2023: dotgithub/CONTRIBUTING.md
- Creating Extensions: extending-wiremock.md
- Governance: community/governance/README.md
- Code of Conduct: dotgithub/CODE_OF_CONDUCT.md
- Resources:
- Community Resources: resources/README.md
- Community Slack: community/slack.md
- Events:
Overview: community/events/README.md
Hacktoberfest: community/events/hacktoberfest/README.md
Archives: https://www.youtube.com/@WireMockChannel/playlists
Speaking: community/contributing/README.md#help-to-spread-the-word
- WireMock Support: dotgithub/SUPPORT.md
- Reporting Security Issues: dotgithub/SECURITY.md
- External Resources: resources/external.md
# Markdown
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- toc:
permalink: '#'