specmatic 0.44.0 → 0.65.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +13 -15
  2. package/package.json +1 -1
  3. package/specmatic.jar +0 -0
package/README.md CHANGED
@@ -1,27 +1,25 @@
1
- [Specmatic](https://specmatic.in/) is a contract driven development tool that allows us to turn our contracts into executable specification. <br />
2
- This node module is a thin wrapper over specmatic.jar originally written in kotlin. All the functionality resides over in the [Specmatic project](https://github.com/znsio/specmatic). This module will help the consumers of specmatic in two ways:
1
+ [Specmatic](https://specmatic.in/) is a contract driven development tool that leverages API Specifications, such as [OpenAPI](https://www.openapis.org/), as executable specification. <br />
2
+
3
+ [![Specmatic - Contract Driven Development](http://img.youtube.com/vi/3HPgpvd8MGg/0.jpg)](http://www.youtube.com/watch?v=3HPgpvd8MGg "Specmatic - Contract Driven Development - Micro-services done right without the pain of integration")
4
+
5
+ ## Thin Wrapper
6
+
7
+ Specmatic is a **standalone executable** that is **agnostic to programming languages and technology stacks**. This node module is a thin wrapper over the [standalone executable jar](https://specmatic.in/getting_started.html#setup). All core capabilities are in the main [Specmatic project](https://github.com/znsio/specmatic). The purpose of this wrapper module is to act as a convenience to help with below aspects.
3
8
  * Easy installation and upgrade of the jar file in node projects through npm
4
- * JS helper library which provides to do various setup steps like start, stop the specmatic stub server, installing specs etc. These helpers methods can be used inside a setup file inside a javascript project programmatically instead of using cli scripts.
9
+ * JS helper library which provides to do various setup steps like start, stop the specmatic stub server, installing specs etc. These helpers methods can be used inside a setup file inside a javascript project programmatically instead of using cli scripts.
5
10
 
6
11
  ## Quick Start
7
12
  `npm install specmatic` will install the specmatic locally to the node project.
8
13
 
9
- Sample npm scripts to run specmatic, with `*.specmatic` as the path of specmatic files and `src/mocks` as the path for the stub data directory (Check [Documentation](https://specmatic.in/documentation.html) for more information on cli commands and arguments.)
10
-
11
- `"specmatic-stub": "specmatic stub *.specmatic --data src/mocks --host=localhost --port=8000"`
12
-
13
- `"specmatic-test": "specmatic test *.specmatic --host=localhost --port=8000"`
14
+ Sample npm scripts to run specmatic, (Check [Documentation](https://specmatic.in/documentation.html) for more information on cli commands and arguments.)
14
15
 
15
- ## Specmatic in stub mode (For consumers)
16
+ ## Contract as Stub / Smart Mock (For API clients / consumers)
16
17
 
17
- In stub mode, Specmatic provides random responses to requests that match the contract. It’s a way of exploring what the contract looks like.
18
- This is meant to be used by anyone who wants to take a fake version of the API for a spin.
19
- This mode can also stub out real requests and responses, which will be validated against the contract before being accepted.
18
+ In stub mode, Specmatic emulates the Provider / API / Service based on the API Specification so that the consumer / client application can make independent progress. [Learn more](https://specmatic.in/#contract-as-stub).
20
19
 
21
- ## Specmatic tests (For Providers)
20
+ ## Contract as Test (For API Providers / Service)
22
21
 
23
- In test mode, Specmatics accepts a contract file, and the hostname and port of the service whose API is being tested. It then sends an HTTP request based on the request format described in the contract for every scenario, generating random values where no examples are given. When the service responds, it validates the response based on the format in the contract.
24
- This is meant to be used by API providers.
22
+ Tests for Free Specmatic parses your API Specification files and based on this generates requests which are fired at your application. It then verifies if your application’s response is as per your API Specification. All this with a “No Code” approach.. [Learn More](https://specmatic.in/#contract-as-test)
25
23
 
26
24
  ## API
27
25
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "specmatic",
3
- "version": "0.44.0",
3
+ "version": "0.65.1",
4
4
  "description": "Node wrapper for Specmatic",
5
5
  "main": "dist/index.js",
6
6
  "scripts": {
package/specmatic.jar CHANGED
Binary file