The produce-service is at repo.
The API for the produce service can be seen here: Produce API
Start local artifactory instance
This will start local artifactory instance. This will be used for storing the stubs that Spring Cloud Contract generates when it executes contracts stored here: produce-contracts
Start up RESTful API:
git clone https://github.com/wkorando/produce-service
cd to the root of that project and run:
Using Spring Cloud Contract Docker
Spring Cloud Contract has a docker image that can read in YAML contracts, see above, and produce stubs for them. This allows non-Java developers to write contracts and generate stubs without having to interact with the Java stack. Steps below demonstrate how to excute contracts to generate stubs and then run a mock server. The mock server reads in the generated stubs and gives stable base to build and test a client against (instead of connecting to a live service which might go down, be misconfigured, or have test data go missing).
Execute Contracts and Generate Stubs
Takes roughly 30 seconds to run. If tests pass stubs will be generated and put in local artifactory.
If tests fail check under
build-output/reports/tests/test/index.html to view report on test run.
Start up Mock Service
This will start a docker image serving up the stubs at
http://localhost:9876. As mentioned above this gives stable endpoint to work against. The response for a given request will always be the same, which is much more stable and easier to work for a client developer. If something is working correctly on the client side, it's because an issue with not matching API behavior, not because backend service is currently down.