Skip to content

Commit

Permalink
Deploying to gh-pages from @ 5ba4dec 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@martinbonnin
martinbonnin committed Dec 6, 2024
1 parent b662808 commit 64379fd
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion HelpTOC.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"entities":{"pages":{"-gpod0z_2":{"id":"-gpod0z_2","title":"GitHub","url":"https://github.com/apollographql/apollo-kotlin-mockserver","level":0,"tabIndex":0},"-gpod0z_3":{"id":"-gpod0z_3","title":"Kdoc","url":"https://apollographql.github.io/apollo-kotlin-mockserver/kdoc","level":0,"tabIndex":1},"getting-started":{"id":"getting-started","title":"Getting-started","url":"getting-started.html","level":0,"tabIndex":2},"recipes":{"id":"recipes","title":"Recipes","url":"recipes.html","level":0,"tabIndex":3},"websockets":{"id":"websockets","title":"WebSockets","url":"websockets.html","level":0,"tabIndex":4}}},"topLevelIds":["-gpod0z_2","-gpod0z_3","getting-started","recipes","websockets"]}
{"entities":{"pages":{"cu0uql_2":{"id":"cu0uql_2","title":"GitHub","url":"https://github.com/apollographql/apollo-kotlin-mockserver","level":0,"tabIndex":0},"cu0uql_3":{"id":"cu0uql_3","title":"Kdoc","url":"https://apollographql.github.io/apollo-kotlin-mockserver/kdoc","level":0,"tabIndex":1},"getting-started":{"id":"getting-started","title":"Getting-started","url":"getting-started.html","level":0,"tabIndex":2},"recipes":{"id":"recipes","title":"Recipes","url":"recipes.html","level":0,"tabIndex":3},"websockets":{"id":"websockets","title":"WebSockets","url":"websockets.html","level":0,"tabIndex":4}}},"topLevelIds":["cu0uql_2","cu0uql_3","getting-started","recipes","websockets"]}
10 changes: 5 additions & 5 deletions getting-started.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html lang="en-US" data-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"><meta name="built-on" content="2024-10-23T08:43:28.293364193"><title>Getting-started | Apollo Kotlin MockServer</title><script type="application/json" id="virtual-toc-data">[{"id":"enqueuing-mock-responses","level":0,"title":"Enqueuing mock responses","anchor":"#enqueuing-mock-responses"},{"id":"reading-recorded-requests","level":0,"title":"Reading recorded requests","anchor":"#reading-recorded-requests"},{"id":"next-steps","level":0,"title":"Next steps","anchor":"#next-steps"}]</script><script type="application/json" id="topic-shortcuts"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.10.0-b408/app.css" rel="stylesheet"><link rel="icon" type="image/png" sizes="16x16" href="images/favicon-96x96.png"><link rel="icon" type="image/png" sizes="32x32" href="images/favicon-192x192.png"><meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Getting-started | Apollo Kotlin MockServer"><meta property="og:description" content=""><meta property="og:image" content=""><meta property="og:site_name" content="Apollo Kotlin MockServer Help"><meta property="og:type" content="website"><meta property="og:locale" content="en_US"><meta property="og:url" content="writerside-documentation/getting-started.html"><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Getting-started | Apollo Kotlin MockServer"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json">{
<html lang="en-US" data-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"><meta name="built-on" content="2024-12-06T17:00:12.437527038"><title>Getting-started | Apollo Kotlin MockServer</title><script type="application/json" id="virtual-toc-data">[{"id":"enqueuing-mock-responses","level":0,"title":"Enqueuing mock responses","anchor":"#enqueuing-mock-responses"},{"id":"reading-recorded-requests","level":0,"title":"Reading recorded requests","anchor":"#reading-recorded-requests"},{"id":"next-steps","level":0,"title":"Next steps","anchor":"#next-steps"}]</script><script type="application/json" id="topic-shortcuts"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.10.0-b408/app.css" rel="stylesheet"><link rel="icon" type="image/png" sizes="16x16" href="images/favicon-96x96.png"><link rel="icon" type="image/png" sizes="32x32" href="images/favicon-192x192.png"><meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Getting-started | Apollo Kotlin MockServer"><meta property="og:description" content=""><meta property="og:image" content=""><meta property="og:site_name" content="Apollo Kotlin MockServer Help"><meta property="og:type" content="website"><meta property="og:locale" content="en_US"><meta property="og:url" content="writerside-documentation/getting-started.html"><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Getting-started | Apollo Kotlin MockServer"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json">{
"@context": "http://schema.org",
"@type": "WebPage",
"@id": "writerside-documentation/getting-started.html#webpage",
Expand All @@ -13,10 +13,10 @@
"@id": "writerside-documentation/#website",
"url": "writerside-documentation/",
"name": "Apollo Kotlin MockServer Help"
}</script><!-- End Schema.org --></head><body data-id="getting-started" data-main-title="Getting-started" data-article-props="{&quot;seeAlsoStyle&quot;:&quot;links&quot;}" data-template="article" data-breadcrumbs="" data-edit-url="https://github.com/apollographql/apollo-kotlin-mockserver/edit/main/Writerside/topics/getting-started.md"><div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Apollo Kotlin MockServer Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="getting-started" id="getting-started.md">Getting-started</h1><p id="wzksqu_3">Apollo MockServer is a <a href="https://kotlinlang.org/docs/multiplatform.html" id="wzksqu_16" data-external="true" rel="noopener noreferrer">KMP</a> server for your HTTP and WebSocket tests.</p><p id="wzksqu_4"><span class="control" id="wzksqu_17">Features:</span></p><ul class="list _bullet" id="wzksqu_5"><li class="list__item" id="wzksqu_18"><p>Enqueue mocked HTTP responses</p></li><li class="list__item" id="wzksqu_19"><p>Dequeue recorded HTTP requests</p></li><li class="list__item" id="wzksqu_20"><p>Enqueue mocked WebSocket messages</p></li><li class="list__item" id="wzksqu_21"><p>Dequeue recorded WebSocket messages</p></li><li class="list__item" id="wzksqu_22"><p>JVM, Native and JS (Node) support</p></li></ul><p id="wzksqu_6">Apollo MockServer was initially developed for <a href="https://github.com/apollographql/apollo-kotlin/" id="wzksqu_23" data-external="true" rel="noopener noreferrer">Apollo Kotlin</a> integration tests and is provided as-is to the community.</p><p id="wzksqu_7">Performance and compatibility are minimal. Do not use in production.</p><p id="wzksqu_8"><span class="control" id="wzksqu_24">Non-goals:</span></p><ul class="list _bullet" id="wzksqu_9"><li class="list__item" id="wzksqu_25"><p>HTTP2/HTTP3</p></li><li class="list__item" id="wzksqu_26"><p>HTTPS/TLS</p></li><li class="list__item" id="wzksqu_27"><p>Performance</p></li></ul><p id="wzksqu_10">Should a future version of <a href="https://ktor.io/docs/server-platforms.html" id="wzksqu_28" data-external="true" rel="noopener noreferrer">Ktor</a> or any other server framework provide a <code class="code" id="wzksqu_29">commonMain</code> API, Apollo Kotlin MockServer would probably become deprecated.</p><p id="wzksqu_11">In the meantime, add the dependency to your project and enjoy cross-platform integration tests!</p><div class="code-block" data-lang="none">
}</script><!-- End Schema.org --></head><body data-id="getting-started" data-main-title="Getting-started" data-article-props="{&quot;seeAlsoStyle&quot;:&quot;links&quot;}" data-template="article" data-breadcrumbs="" data-edit-url="https://github.com/apollographql/apollo-kotlin-mockserver/edit/main/Writerside/topics/getting-started.md"><div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Apollo Kotlin MockServer Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="getting-started" id="getting-started.md">Getting-started</h1><p id="skfwuu_3">Apollo MockServer is a <a href="https://kotlinlang.org/docs/multiplatform.html" id="skfwuu_16" data-external="true" rel="noopener noreferrer">KMP</a> server for your HTTP and WebSocket tests.</p><p id="skfwuu_4"><span class="control" id="skfwuu_17">Features:</span></p><ul class="list _bullet" id="skfwuu_5"><li class="list__item" id="skfwuu_18"><p>Enqueue mocked HTTP responses</p></li><li class="list__item" id="skfwuu_19"><p>Dequeue recorded HTTP requests</p></li><li class="list__item" id="skfwuu_20"><p>Enqueue mocked WebSocket messages</p></li><li class="list__item" id="skfwuu_21"><p>Dequeue recorded WebSocket messages</p></li><li class="list__item" id="skfwuu_22"><p>JVM, Native and JS (Node) support</p></li></ul><p id="skfwuu_6">Apollo MockServer was initially developed for <a href="https://github.com/apollographql/apollo-kotlin/" id="skfwuu_23" data-external="true" rel="noopener noreferrer">Apollo Kotlin</a> integration tests and is provided as-is to the community.</p><p id="skfwuu_7">Performance and compatibility are minimal. Do not use in production.</p><p id="skfwuu_8"><span class="control" id="skfwuu_24">Non-goals:</span></p><ul class="list _bullet" id="skfwuu_9"><li class="list__item" id="skfwuu_25"><p>HTTP2/HTTP3</p></li><li class="list__item" id="skfwuu_26"><p>HTTPS/TLS</p></li><li class="list__item" id="skfwuu_27"><p>Performance</p></li></ul><p id="skfwuu_10">Should a future version of <a href="https://ktor.io/docs/server-platforms.html" id="skfwuu_28" data-external="true" rel="noopener noreferrer">Ktor</a> or any other server framework provide a <code class="code" id="skfwuu_29">commonMain</code> API, Apollo Kotlin MockServer would probably become deprecated.</p><p id="skfwuu_11">In the meantime, add the dependency to your project and enjoy cross-platform integration tests!</p><div class="code-block" data-lang="none">
[libraries]
apollo-mockserver = &quot;com.apollographql.mockserver:apollo-mockserver:0.1.0&quot;
</div><section class="chapter"><h2 id="enqueuing-mock-responses" data-toc="enqueuing-mock-responses">Enqueuing mock responses</h2><p id="wzksqu_30">To enqueue responses, use <code class="code" id="wzksqu_33">MockServer.enqueue</code>:</p><div class="code-block" data-lang="kotlin">
</div><section class="chapter"><h2 id="enqueuing-mock-responses" data-toc="enqueuing-mock-responses">Enqueuing mock responses</h2><p id="skfwuu_30">To enqueue responses, use <code class="code" id="skfwuu_33">MockServer.enqueue</code>:</p><div class="code-block" data-lang="kotlin">
// .use {} makes sure to release the resources at the end of the test
MockServer().use { mockServer -&gt;
mockServer.enqueue(
Expand All @@ -28,7 +28,7 @@

// You can enqueue multiple responses if needed
}
</div><aside class="prompt" data-type="note" data-title="" id="wzksqu_32"><p id="wzksqu_34"><code class="code" id="wzksqu_35">MockServer</code> holds resources and must be closed after use. <code class="code" id="wzksqu_36">.use {}</code> does it automatically.</p></aside></section><section class="chapter"><h2 id="reading-recorded-requests" data-toc="reading-recorded-requests">Reading recorded requests</h2><p id="wzksqu_37">Use <code class="code" id="wzksqu_39">MockServer.awaitRequest()</code> to retrieve a recorded request that you can assert to check the behaviour of your client code.</p><div class="code-block" data-lang="kotlin">
</div><aside class="prompt" data-type="note" data-title="" id="skfwuu_32"><p id="skfwuu_34"><code class="code" id="skfwuu_35">MockServer</code> holds resources and must be closed after use. <code class="code" id="skfwuu_36">.use {}</code> does it automatically.</p></aside></section><section class="chapter"><h2 id="reading-recorded-requests" data-toc="reading-recorded-requests">Reading recorded requests</h2><p id="skfwuu_37">Use <code class="code" id="skfwuu_39">MockServer.awaitRequest()</code> to retrieve a recorded request that you can assert to check the behaviour of your client code.</p><div class="code-block" data-lang="kotlin">
// .use {} makes sure to release the resources at the end of the test
MockServer().use { mockServer -&gt;
mockServer.enqueue(...)
Expand All @@ -42,4 +42,4 @@
// ...
}
}
</div></section><section class="chapter"><h2 id="next-steps" data-toc="next-steps">Next steps</h2><p id="wzksqu_40">Take a look at the <a href="recipes.html" id="wzksqu_41" data-tooltip="Recipes mockServer.enqueueString( string = &quot;{\&quot;status\&quot;:200}&quot;, contentType = &quot;application/json&quot; ) mockServer.enqueueError(500) mockServer.enqueueMultipart( partsContentType = &quot;application/json&quot; ).apply { enqueuePart(&quot;{\&quot;part\&quot;:…">Recipes</a> or <a href="websockets.html" id="wzksqu_42" data-tooltip="Apollo Kotlin MockServer supports WebSockets">WebSockets</a> pages to learn more.</p></section><div class="last-modified">Last modified: 19 July 2024</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"><a href="recipes.html" class="navigation-links__next">Recipes</a></div></article><div id="disqus_thread"></div></div></section></main></div><script src="https://resources.jetbrains.com/writerside/apidoc/6.10.0-b408/app.js"></script></body></html>
</div></section><section class="chapter"><h2 id="next-steps" data-toc="next-steps">Next steps</h2><p id="skfwuu_40">Take a look at the <a href="recipes.html" id="skfwuu_41" data-tooltip="Recipes mockServer.enqueueString( string = &quot;{\&quot;status\&quot;:200}&quot;, contentType = &quot;application/json&quot; ) mockServer.enqueueError(500) mockServer.enqueueMultipart( partsContentType = &quot;application/json&quot; ).apply { enqueuePart(&quot;{\&quot;part\&quot;:…">Recipes</a> or <a href="websockets.html" id="skfwuu_42" data-tooltip="Apollo Kotlin MockServer supports WebSockets">WebSockets</a> pages to learn more.</p></section><div class="last-modified">Last modified: 19 July 2024</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"><a href="recipes.html" class="navigation-links__next">Recipes</a></div></article><div id="disqus_thread"></div></div></section></main></div><script src="https://resources.jetbrains.com/writerside/apidoc/6.10.0-b408/app.js"></script></body></html>
2 changes: 1 addition & 1 deletion recipes.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html lang="en-US" data-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"><meta name="built-on" content="2024-10-23T08:43:28.280773999"><title>Recipes | Apollo Kotlin MockServer</title><script type="application/json" id="virtual-toc-data">[{"id":"enqueue-string-responses","level":0,"title":"Enqueue String responses","anchor":"#enqueue-string-responses"},{"id":"enqueue-error-responses","level":0,"title":"Enqueue Error responses","anchor":"#enqueue-error-responses"},{"id":"enqueue-multipart-responses","level":0,"title":"Enqueue Multipart responses","anchor":"#enqueue-multipart-responses"},{"id":"add-an-artificial-delay","level":0,"title":"Add an artificial delay","anchor":"#add-an-artificial-delay"}]</script><script type="application/json" id="topic-shortcuts"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.10.0-b408/app.css" rel="stylesheet"><link rel="icon" type="image/png" sizes="16x16" href="images/favicon-96x96.png"><link rel="icon" type="image/png" sizes="32x32" href="images/favicon-192x192.png"><meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Recipes | Apollo Kotlin MockServer"><meta property="og:description" content=""><meta property="og:image" content=""><meta property="og:site_name" content="Apollo Kotlin MockServer Help"><meta property="og:type" content="website"><meta property="og:locale" content="en_US"><meta property="og:url" content="writerside-documentation/recipes.html"><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Recipes | Apollo Kotlin MockServer"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json">{
<html lang="en-US" data-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"><meta name="built-on" content="2024-12-06T17:00:12.423938188"><title>Recipes | Apollo Kotlin MockServer</title><script type="application/json" id="virtual-toc-data">[{"id":"enqueue-string-responses","level":0,"title":"Enqueue String responses","anchor":"#enqueue-string-responses"},{"id":"enqueue-error-responses","level":0,"title":"Enqueue Error responses","anchor":"#enqueue-error-responses"},{"id":"enqueue-multipart-responses","level":0,"title":"Enqueue Multipart responses","anchor":"#enqueue-multipart-responses"},{"id":"add-an-artificial-delay","level":0,"title":"Add an artificial delay","anchor":"#add-an-artificial-delay"}]</script><script type="application/json" id="topic-shortcuts"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.10.0-b408/app.css" rel="stylesheet"><link rel="icon" type="image/png" sizes="16x16" href="images/favicon-96x96.png"><link rel="icon" type="image/png" sizes="32x32" href="images/favicon-192x192.png"><meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Recipes | Apollo Kotlin MockServer"><meta property="og:description" content=""><meta property="og:image" content=""><meta property="og:site_name" content="Apollo Kotlin MockServer Help"><meta property="og:type" content="website"><meta property="og:locale" content="en_US"><meta property="og:url" content="writerside-documentation/recipes.html"><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Recipes | Apollo Kotlin MockServer"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json">{
"@context": "http://schema.org",
"@type": "WebPage",
"@id": "writerside-documentation/recipes.html#webpage",
Expand Down
Loading

0 comments on commit 64379fd

Please sign in to comment.