{"id":18875829,"url":"https://github.com/wiremock/kotlin-wiremock","last_synced_at":"2025-10-24T19:46:54.188Z","repository":{"id":37077598,"uuid":"267131008","full_name":"wiremock/kotlin-wiremock","owner":"wiremock","description":"Kotlin DSL for WireMock","archived":false,"fork":false,"pushed_at":"2024-04-11T14:28:40.000Z","size":139,"stargazers_count":50,"open_issues_count":6,"forks_count":7,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-08-04T21:22:38.304Z","etag":null,"topics":["kotlin","kotlin-dsl","wiremock"],"latest_commit_sha":null,"homepage":"https://wiremock.org/docs/solutions/kotlin/","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wiremock.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-05-26T19:16:14.000Z","updated_at":"2025-02-26T11:28:04.000Z","dependencies_parsed_at":"2022-08-19T08:01:03.950Z","dependency_job_id":"a6b66c1e-1d1b-420b-a167-5cc8a008d5f4","html_url":"https://github.com/wiremock/kotlin-wiremock","commit_stats":null,"previous_names":["wiremock/kotlin-wiremock","marcinziolo/kotlin-wiremock"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/wiremock/kotlin-wiremock","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wiremock%2Fkotlin-wiremock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wiremock%2Fkotlin-wiremock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wiremock%2Fkotlin-wiremock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wiremock%2Fkotlin-wiremock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wiremock","download_url":"https://codeload.github.com/wiremock/kotlin-wiremock/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wiremock%2Fkotlin-wiremock/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280857801,"owners_count":26403193,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-24T02:00:06.418Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["kotlin","kotlin-dsl","wiremock"],"created_at":"2024-11-08T06:09:18.883Z","updated_at":"2025-10-24T19:46:54.161Z","avatar_url":"https://github.com/wiremock.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kotlin DSL for WireMock\n\n[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.marcinziolo/kotlin-wiremock/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.marcinziolo/kotlin-wiremock)\n![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/wiremock/kotlin-wiremock/workflow.yaml)\n[![codecov](https://codecov.io/gh/marcinziolo/kotlin-wiremock/branch/master/graph/badge.svg)](https://codecov.io/gh/marcinziolo/kotlin-wiremock)\n\nThis is library provides handy kotlin dsl for [WireMock](http://wiremock.org/) stubbing.\nRead more about WireMock and Kotlin [here](https://wiremock.org/docs/solutions/kotlin/).\n\n### Getting started\n\nGradle\n```kotlin\n  testImplementation(\"com.marcinziolo:kotlin-wiremock:version\")\n```\n\nMaven\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.marcinziolo\u003c/groupId\u003e\n    \u003cartifactId\u003ekotlin-wiremock\u003c/artifactId\u003e\n    \u003cversion\u003e:version\u003c/version\u003e\n    \u003cscope\u003etest\u003c/scope\u003e\n\u003c/dependency\u003e\n```\n### Features\n\n* Request Matching\n    * Http methods (post/get/put/delete/patch/options/head/trace/any)\n        ```kotlin\n        wiremock.post {\n            url equalTo \"/users/1\"\n        } returnsJson {\n          body = \"\"\"\n          {\n            \"id\": 1,\n            \"name\": \"Bob\"\n          }\n          \"\"\"\n        }\n        ```       \n    * JSON body - with strong type checking of json value\n        ```kotlin\n        wiremock.post {\n            body contains \"id\" equalTo 1\n            body contains \"name\" like \"Alice\"\n            body contains \"isAdmin\" equalTo true\n            body contains \"points\" equalTo 3.0\n            body contains \"lastName\" // just checking if key exists\n        }\n        ```\n    * Headers\n        ```kotlin\n        wiremock.post {\n            headers contains \"User-Agent\" like \"Firefox.*\" \n        }\n        ``` \n    * Query parameters\n        ```kotlin\n        wiremock.post {\n            urlPath equalTo \"/users/1\"\n            queryParams contains \"page\" like \"1.*\" \n        }  \n        ```  \n    * Priority\n        ```kotlin\n        wiremock.post {\n            url equalTo \"/test\"\n            priority = 2\n        } returnsJson  {\n            statusCode = 403\n        }\n\n        wiremock.post {\n            url equalTo \"/test\"\n            headers contains \"Authorization\"\n            priority = 1\n        } returnsJson  {\n            statusCode = 200\n        }\n        ```\n    * Cookies        \n* Response specification\n    * Returns\n        ```kotlin\n        wiremock.get {\n            url equalTo \"/users/1\"\n        } returns {\n            statusCode = 200\n            header = \"Content-Type\" to \"application/json\"\n            body = \"\"\"\n            {\n              \"id\": 1,\n              \"name\": \"Bob\"\n            }\n            \"\"\"\n        }\n        ```\n    * Or easier `returnsJson`\n        ```kotlin\n        wiremock.get {\n            url equalTo \"/users/1\"\n        } returnsJson {\n            body = \"\"\"\n            {\n              \"id\": 1,\n              \"name\": \"Bob\"\n            }\n            \"\"\"\n        }\n        ```\n    * Delays\n      ```kotlin\n      wiremock.post {\n          url equalTo \"/users\"\n      } returnsJson {\n          delay fixedMs 100\n          //or gaussian distribution\n          delay medianMs 100 sigma 0.1\n      }       \n      ``` \n* Chaining\n     ```kotlin\n      val bobResponse: SpecifyResponse = {\n          body = \"\"\"\n              {\n                \"id\": 1,\n                \"name\": \"Bob\"\n              }\n              \"\"\"\n      }\n  \n      wiremock.post {\n          url equalTo \"/users\"\n      } and {\n          body contains \"id\" equalTo 1\n      } and {\n          body contains \"isAdmin\" equalTo true\n      } returns {\n          header = \"Content-Type\" to \"application/json\"\n      } and bobResponse and {\n          statusCode = 201\n      }\n     ```\n* Scenarios - stateful behaviour\n   ```kotlin\n    wiremock.post {\n        url equalTo \"/users\"\n    } returnsJson bobResponse and {\n        toState = \"Alice\"\n    }\n\n    wiremock.post {\n        url equalTo \"/users\"\n        whenState = \"Alice\"\n    } returnsJson aliceResponse and {\n        clearState = true\n    }\n   ```\n* Verification api\n   ```kotlin\n    wm.verify {\n       headers contains \"User-Agent\" equalTo \"curl\"\n       queryParams contains \"filter\" equalTo \"true\"\n       cookies contains \"cookieKey\" equalTo \"cookieValue\"\n       body contains \"pet\" equalTo \"dog\"\n   }\n  \n   //exactly\n   wm.verify {\n     urlPath equalTo \"/users/1\"\n     exactly = 1\n   } moreThan 2 //lessThan lessThanOrEqual  moreThanOrEqual\n  \n   //atLeast atMost\n   wm.verify {\n     urlPath equalTo \"/users/1\"\n     atLeast = 1\n     atMost = 3\n   }\n   ```  \n\n* WiremMckTest Junit5 extension\n    ```kotlin\n    class Junit5RegisterExtensionTest {\n    \n        @JvmField\n        @RegisterExtension\n        var wm = WireMockExtension.newInstance()\n                .options(wireMockConfig().dynamicPort())\n                .build()\n    \n        @Test\n        fun testGet() {\n            wm.get {\n                url equalTo \"/hello\"\n            } returns {\n                statusCode = 200\n            }\n    \n            When {\n                get(\"${wm.baseUrl()}/hello\")\n            } Then {\n                statusCode(200)\n            }\n        }\n    }\n    ```\n#### More examples\n\n* [Examples.kt](src/test/kotlin/com/marcinziolo/kotlin/wiremock/ExampleTest.kt)\n* [JUnit4 example](kotlin-wiremock-examples/src/test/kotlin/com/marcinziolo/kotlin/wiremock/JUnit4ExampleTest.kt)\n* [Junit5 base class](src/test/kotlin/com/marcinziolo/kotlin/wiremock/AbstractTest.kt)\n* [Verification test cases](src/test/kotlin/com/marcinziolo/kotlin/wiremock/Verify.kt)\n* [WithBuilderTests](src/test/kotlin/com/marcinziolo/kotlin/wiremock/otherPackage/WithBuilderTest.kt) - extension point for using original wiremock api and its extensions(like webhooks)\n\n### Compatibility\n\nThe Library is compatible with WireMock - 2.8.0 and higher\n\n### Release notes\n\n| Version | Notes                                                                                                                                                                                                                                                                                                                                      |\n|:-------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n|  2.0.2  | Supports WireMock 3.0.0 and Jetty 11                                                                                                                                                                                                                                                                                                       |\n|  2.0.0  | Breaking change for verification DSL - changed api for specifying counting                                                                                                                                                                                                                                                                 |\n|  1.1.0  | Introduced DSL for [verfication API](https://wiremock.org/docs/verifying/)                                                                                                                                                                                                                                                                 |\n|  1.0.5  | In version 1.0.4 `url` argument (eg.`url equalTo \"/hello\"`) was treated as a path and matches only a path of url, which was wrong and misleading, in version 1.0.5 it was fixed and new keyword `urlPath` was introduced for matching a path of url (eg.`urlPath equalTo \"/hello\"`). Note: `url` has precedence in case both are specified |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwiremock%2Fkotlin-wiremock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwiremock%2Fkotlin-wiremock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwiremock%2Fkotlin-wiremock/lists"}