Skip to content

Latest commit

 

History

History

documented

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

Documented Example

This example demonstrates how to write the description of an HTTP API once and then get for free both the HTTP server implementation and the OpenAPI documentation.

The application implements a counter whose value can be queried and updated. All the code lives in a single file Counter.scala.

Try it by starting sbt from within the repository root directory, and then invoke the following task:

> example-documented/reStart

And then browse http://localhost:8080.

You can play with the API directly from the Swagger UI to query the counter value and change it.