sohoffice / play-docgen-seed

Sample projects to use descriptive-play-swagger to streamline swagger doc generation.

decriptive-play-swagger can read your routes file and generate swagger spec, your scaladoc are extracted and populated as descriptions in your spec file.

Once we have the swagger spec, Swagger Codegen can be used to generate server access stubs or client code.

The project can be used under the following prerequisites

• play 2.7+
• scala 2.12
• sbt 1.0+
• is a scala project

Usage

Simply clone the project and execute the following run.

sbt ~run

swagger spec should be generated by the time your project run. You may find the swagger console at http://localhost:9000/.

You can also manually execute sbt swagger to regenerate the spec.