From 27d1cbe5105c566be88d268f02ef2785cf5bd1da Mon Sep 17 00:00:00 2001 From: Marcel Pociot Date: Thu, 12 May 2016 00:16:32 +0200 Subject: [PATCH] Show example output --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 299f6e92..619cf2e2 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,8 @@ This package uses the HTTP controller doc blocks to create a table of contents a public function foo() ``` +**Result:** ![Doc block result](http://marcelpociot.com/documentarian/doc_block.png) + #### Form request validation rules To display a list of valid parameters, your API methods accepts, this package uses Laravels [Form Requests Validation](https://laravel.com/docs/5.2/validation#form-request-validation). @@ -72,10 +74,14 @@ public function rules() return [ 'title' => 'required|max:255', 'body' => 'required', + 'type' => 'in:foo,bar', + 'thumbnail' => 'required_if:type,foo|image' ]; } ``` +**Result:** ![Form Request](http://marcelpociot.com/documentarian/form_request.png) + #### API responses If your API route accepts a `GET` method, this package tries to call the API route with all middleware disabled to fetch an example API response.