README.md

Lagom OpenAPI Demo: How do I generate OpenAPI Specification for Lagom service?

This example demonstrates, how you can generate OpenAPI Specification for Lagom service. It uses the Lagom OpenAPI library.

⚠️   For see an example for Lagom 1.4.x, switch to openapi-1.4.x branch.

About service

This is a simple Petstor service, which is often used as examples for demonstrating capabilities OpenAPI/Swagger specifications.

Testing the example

unit tests

You can test this example using the provided tests:

./mvnw verify

manual tests

You can also test this example manually:

1. Open terminal and start the service

./mvnw lagom:runAll

2. Open next link in the browser to get OpenAPI Specification:

http://localhost:9000/_pets/openapi[?format=json|yaml]