When using light-codegen with Swagger 2.0 specification to generate light-rest-4j project,
you can add examples into the specification definition so that the generated project will
have handlers to return corresponding examples.
This is very useful for developers who are working on the service to verify that the service
is working right off the generator.
Also it is very useful for client side developers as they can get an running service right
off the specification to start their client side application development. Later on they
can switch to the real implementation to do the integration test.
This kind of support ensures that client side development and server side development can
be running in parallel to speed up the overall delivery process. It is particular useful
with microservivces architecture as each team will only focus on their own service but use
other teams mock services to start the development.
To leverage this feature in Swagger 2.0 specification, you need to define the example in
each endpoint or operation.