浏览代码

Allow indication of binary responses (fix mpociot/laravel-apidoc-generator#479)

shalvah 5 年之前
父节点
当前提交
863259386b

+ 1 - 2
README.md

@@ -2,8 +2,7 @@
 
 Automatically generate your API documentation from your existing Laravel/Lumen/[Dingo](https://github.com/dingo/api) routes. [Here's what the output looks like](https://shalvah.me/TheCensorshipAPI/).
 
-[![Latest Stable Version](https://poser.pugx.org/knuckleswtf/scribe/v/stable)](https://packagist.org/packages/knuckleswtf/scribe)[![Total Downloads](https://poser.pugx.org/knuckleswtf/scribe/downloads)](https://packagist.org/packages/knuckleswtf/scribe)
-[![Build Status](https://travis-ci.org/knuckleswtf/scribe.svg?branch=master)](https://travis-ci.org/knuckleswtf/scribe)
+[![Latest Stable Version](https://poser.pugx.org/knuckleswtf/scribe/v/stable)](https://packagist.org/packages/knuckleswtf/scribe)[![Total Downloads](https://poser.pugx.org/knuckleswtf/scribe/downloads)](https://packagist.org/packages/knuckleswtf/scribe) [![Build Status](https://travis-ci.org/knuckleswtf/scribe.svg?branch=master)](https://travis-ci.org/knuckleswtf/scribe) [![Total Downloads](https://poser.pugx.org/knuckleswtf/scribe/downloads)](https://packagist.org/packages/knuckleswtf/scribe)
 
 ## Installation
 PHP 7.2 and Laravel/Lumen 5.7 or higher are required.

+ 2 - 0
resources/views/partials/route.blade.php

@@ -18,6 +18,8 @@
 ```json
 @if(is_object($response['content']) || is_array($response['content']))
 {!! json_encode($response['content'], JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) !!}
+@elseif(\Illuminate\Support\Str::startsWith($response['content'], "<<binary>>"))
+Binary data - {{ str_replace("<<binary>>","",$response['content']) }}
 @else
 {!! json_encode(json_decode($response['content']), JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) !!}
 @endif

+ 1 - 0
src/Extracting/Strategies/Responses/UseResponseTag.php

@@ -53,6 +53,7 @@ class UseResponseTag extends Strategy
         }
 
         $responses = array_map(function (Tag $responseTag) {
+            // Status code (optional) followed by response
             preg_match('/^(\d{3})?\s?([\s\S]*)$/', $responseTag->getContent(), $result);
 
             $status = $result[1] ?: 200;

+ 0 - 3
src/Writing/Writer.php

@@ -318,12 +318,9 @@ class Writer
         $oldFileModificationTime = $this->lastTimesWeModifiedTheseFiles[$filePath] ?? null;
 
         if ($oldFileModificationTime) {
-            var_dump($oldFileModificationTime);
             $latestFileModifiedTime = filemtime($filePath);
-            var_dump($latestFileModifiedTime);
             $wasFileModifiedManually = $latestFileModifiedTime > (int)$oldFileModificationTime;
 
-            var_dump($wasFileModifiedManually);
             return $wasFileModifiedManually;
         }