Sha256: fb0ba25ce6689501e56ee2d2b233dad6533a4c755f16a1978246a7b5950accc1

Contents?: true

Size: 685 Bytes

Versions: 9

Compression:

Stored size: 685 Bytes

Contents

# API
## Hello World

<% namespace_store.each do |name, namespace| %>
## <%= name.capitalize %>

<% namespace.all_endpoints.each do |endpoint| %>
### <%= endpoint.name.capitalize %> [<%= endpoint.method.upcase %> <%= endpoint.full_path %>]

<% if payload_schema = endpoint.schema_for(:payload) %>
#### Payload

The payload is an instance of the **<%= payload_schema.name %>** schema.

  ```json
<%= json_example payload_schema %>
  ```
<% end %>

#### Response
<% if response_schema = endpoint.schema_for(:response) %>
Returns schema **<%= response_schema.name %>**

  ```json
<%= json_example response_schema %>
  ```
<% else %>
The response is empty.
<% end %>

<% end %>

<% end %>

Version data entries

9 entries across 9 versions & 1 rubygems

Version Path
restspec-0.3.2 lib/restspec/runners/docs/templates/docs.md.erb
restspec-0.3.1 lib/restspec/runners/docs/templates/docs.md.erb
restspec-0.3.0 lib/restspec/runners/docs/templates/docs.md.erb
restspec-0.2.6 lib/restspec/runners/docs/templates/docs.md.erb
restspec-0.2.5 lib/restspec/runners/docs/templates/docs.md.erb
restspec-0.2.4 lib/restspec/runners/docs/templates/docs.md.erb
restspec-0.2.3 lib/restspec/runners/docs/templates/docs.md.erb
restspec-0.2.2 lib/restspec/runners/docs/templates/docs.md.erb
restspec-0.2.1 lib/restspec/runners/docs/templates/docs.md.erb