Sha256: d1e7fa8a07a123dae4e81ef5186b06319dc6e5c5564d5f33866e356118a1f7ed

Contents?: true

Size: 874 Bytes

Versions: 1

Compression:

Stored size: 874 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.

<% sample = Restspec::Schema::SchemaExample.new(payload_schema).value %>

  ```json
<%= JSON.pretty_generate(sample).gsub(/^/, '  ') %>
  ```

<% end %>

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

  <% sample = Restspec::Schema::SchemaExample.new(response_schema).value %>

  ```json
<%= JSON.pretty_generate(sample).gsub(/^/, '  ') %>
  ```
<% else %>
  The response is empty.
<% end %>

<% end %>

<% end %>

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
restspec-0.2 lib/restspec/runners/docs/templates/docs.md.erb