yesod-raml-bin: The raml helper executable.

[ mit, program, web, yesod ] [ Propose Tags ] [ Report a vulnerability ]

Provides html documentation and route file generator


[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0, 0.1.1, 0.1.2
Change log ChangeLog.md
Dependencies base (>=4 && <5), blaze-html, blaze-markup, bytestring, containers, http-types, optparse-applicative, shakespeare, template-haskell, text, wai, warp, yaml, yesod-core, yesod-markdown, yesod-raml (>=0.2 && <0.3), yesod-raml-docs (>=0.1 && <0.2), yesod-raml-mock (>=0.1 && <0.2) [details]
License MIT
Author junji.hashimoto
Maintainer junji.hashimoto@gmail.com
Category Web, Yesod
Bug tracker https://github.com/junjihashimoto/yesod-raml/issues
Source repo head: git clone https://github.com/junjihashimoto/yesod-raml.git
Uploaded by junjihashimoto at 2015-11-10T01:25:45Z
Distributions
Reverse Dependencies 1 direct, 0 indirect [details]
Executables yesod-raml-bin
Downloads 1888 total (6 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs not available [build log]
Last success reported on 2015-11-14 [all 5 reports]

Readme for yesod-raml-bin-0.1.2

[back to package description]

Yesod-Raml-Bin:

Yesod-Raml-Bin is a utility program for yesod-raml. The functions are below.

  • Verify RAML format
  • Convert RAML to HTML
  • Convert RAML to Yesod-Route file
  • Generate mock-handler code
  • Run mock server

Usage

Verify RAML file. (Curretly just use parser of Data.Yaml.)

> yesod-raml-bin verfiy "raml file"

Convert RAML to HTML.

> yesod-raml-bin tohtml "raml file" "html file"

Generate routes file for Yesod.

> yesod-raml-bin toroute "raml file" "routes file"

Generate mock-handler code

> yesod-raml-bin tomock "raml file" "haskell mock code"

Run mock-server

> yesod-raml-bin mock-server -p "port(default: 3000)" "raml file"