ze-goggles v0.1.4

Static api documentation generation

zego

npm install -g ze-goggles
zego -i my_doc.json -o my_doc.md

example

[
   {
      "title":"Hello",
      "description":"Say hello to Joe",
      "req":{
         "method":"post",
         "uri":"http://localhost:3001/mirror",
         "json":{
            "my":"me"
         }
      },
      "res":{
         "statusCode":200,
         "headers":{
            "content-type":"application/json",
            "content-length":"11",
            "date":"Mon, 09 Jun 2014 06:45:03 GMT",
            "connection":"keep-alive"
         },
         "body":{
            "my":"me"
         }
      }
]

result

  #Hello
  ### Say hello to the mirror
  ##### post /mirror
  ```!
  // req
  {
      "my": "me"
  }
  ```!
  ```!
  // res
  {
      "my": "me"
  }
  ```!