Spring Cloud Gateway can be used to Mock APIs while still providing typical gateway proxying functionality. The ability to mock specific APIs can be extremely helpful during frontend or backend SDLC phases, when dependencies aren’t yet available.
This service is built on top of Spring Cloud Gateway. To mock endpoints, add required properties in configuration. Configuration can also be used to add proxies, if needed.
- Technology stack: Built on top of Spring Cloud Gateway (which provides proxying capabilities) to provide mock APIs. The current version is based on Java (JDK11). This service can be used independently in an ecosystem of services/REST APIs like a proxy/mock APIs. The Mock APIs is YAML based easy to use configuration where mock data can be configured as file or config key. The mock response format can be JSON, XML etc.
- Status: v1.0.0 is stable. Refer CHANGELOG for new changes.
- There are Mock APIs like Mock-Server, MockApi, Beeceptor, or Mocky etc. Most other mocking solutions are only focused on providing mock API responses. This approach provides both gateway and mocking capability, which can be beneficial in many scenarios.
Gateway Mock APIs depends on below software:
- Java
- Maven
Maven tool is required to compile the code. Below is command line:
mvn install# Maven command to build
mvn install
# To run the application
java -jar gateway-mock-service.jar --spring.config.location=optional:classpath:/,optional:classpath:properties/local/,optional:classpath:mock/
OR
mvn spring-boot:run -Dspring-boot.run.jvmArguments='-Dspring.config.location=optional:classpath:/,optional:classpath:properties/local/,optional:classpath:mock/'
-Dspring.config.location=optional:classpath:/,optional:classpath:properties/local/,optional:classpath:mock/
Refer to CONFIGURATION document for configuring Gateway Mock APIs.
Refer to Spring Cloud Gateway for proxying or gateway configuration. Use Gateway Mock APIs service to call any configured mock endpoint. Refer to CONFIGURATION on how to configure mock APIs.
Note: This sample is focused only on mocking APIs. Please consider request sanitization, error handling, etc. before using within your architecture.
By default, local configuration adds two mock endpoints http://localhost:8089/api/sample/file and http://localhost:8089/api/sample/config.
Use curl to call default mock endpoints:
# mock response using json file(/main/resources/local/mock/sample.json)
curl localhost:8089/api/sample/file
# mock response using key configuration(local/application.yml -> sampleConfigResponseKey)
curl localhost:8089/api/sample/configJUnit test cases are configured to run the above endpoints. Refer Spring's Actuator guide to verify route configuration applied by the gateway and mock configuration.
N/A
Please raise issues for enhancement, problems and feature ideas.
Using Spring Cloud Gateway with a mocking capability adds a lot of benefit to the SDLC while dependencies aren’t available yet. Help us make this project even better!
There are still few features which are not supported. like:
- Dynamic response using HTTP header or authentication token as mapper.
- Dynamic configuration of mockServiceHost property.
- Define apiGatewayHost for each mock API configuration.
See: CONTRIBUTING.
Gateway Mock APIs is Open Source software released under the Apache 2.0 license.