An SBT plugin that uses webapi-parser, Twirl (Play template engine) and Remark to convert RAML 1.0 into readable markdown files that can be used as documentation for your RESTful APIs.
Update your project/plugins.sbt file to include the following:
resolvers += Resolver.bintrayIvyRepo("peterhazell", "sbt-plugins")
resolvers += "MuleSoftReleases" at "https://repository.mulesoft.org/nexus/content/repositories/public/"
addSbtPlugin("com.petehazell" %% "sbt-raml2md" % "0.3.0")sbt version 0.13.5 and scala version 2.12.2 or higher are required to use this plugin.
From the root directory of your project, run sbt raml2md, this will find any RAML files and output the resulting markdown files.
Separate markdown files will be produced containing the high level API documentation as well as more detailed documentation for each endpoint and associated HTTP method your API supports.
- API name
- Methods and paths
- Names and descriptions
- Query parameter information
- URI parameter information
- Request body JSON examples
- Request body JSON schemas
- Response HTTP status codes
- Response body JSON examples
- Response body JSON schemas