README.md

API First - TDD for integration tests - On cloud microservice architecture

Karate Version

Focus on the contract, specification and the implementation. Nothing else.

Documentation, Models and API interface should auto-generated by your specification.

Development flow

1. Write your contract @ api/src/test/resources/contracts
2. Watch your application will fail tests
3. Design the api Specification @ api/src/main/java/resources/
4. Watch your application fail compilation due to unattended api
5. Implement the code on your controller @ server/src/main/java/
6. Watch your tests pass
7. Play with your api @ localhost:8080/swagger-ui.html
8. Enjoy some coffee

Pros

• Free yourself from updating swagger docs on the controller
• Free yourself from models boilerplate
• Free yourself from client boilerplate
• Use stubs to test client apps without lifting this microservice (stubs are a mocked-service of this microservice)

Libs that made this possible

• OpenAPI-generator : generates your api from apenapi spec
• Karate : quick api testing
• OpenFeign : Declarative API clients
• Hystrix : Circuit-breaker pattern on the easy
• Spring : for having easy integrations for everything above