Sha256: 0415ec401b8d33802b1421a52b812153986ffdee5b340448826ed330a8811ddc

Contents?: true

Size: 838 Bytes

Versions: 8

Compression:

Stored size: 838 Bytes

Contents

h1. Rest Api Documentation (grape-doc)

h2. GET: /hello(.:format)

h3. Request

h4. description

* Hello world!

h4. params

* test
** required: false
** type: String
** desc: it's a test string

h3. Response

h4. example

h5. curl sample with /hello

<pre>$ curl -X GET "http://example.org/hello?test=hy" -H "Accept-Version: v1" -H "X-Token: blabla"</pre>

* status code: 200
* format type: json

h6. raw response body

<pre>{"hello":"world!"}</pre>

h6. json formatted body with Class types

<pre>{
  "hello": "String"
}</pre>

h5. curl sample with /hello.json

<pre>$ curl -X GET "http://example.org/hello.json?" -H "Accept-Version: v1" -H "X-Token: blabla"</pre>

* status code: 200
* format type: json

h6. raw response body

<pre>{"hello":"world!"}</pre>

h6. json formatted body with Class types

<pre>{
  "hello": "String"
}</pre>

Version data entries

8 entries across 8 versions & 1 rubygems

Version Path
grape-doc-0.6.1 test/sample.textile
grape-doc-0.6.0 test/sample.textile
grape-doc-0.5.1 test/sample.textile
grape-doc-0.5.0 test/sample.textile
grape-doc-0.4.3 test/sample.textile
grape-doc-0.4.2 test/sample.textile
grape-doc-0.4.1 test/sample.textile
grape-doc-0.4.0 test/sample.textile