Merge pull request rakutentech#13 from rakutentech/patch/rawahamid

Patch/rawahamid

Author: kevincobain2000

README.md

@@ -2,6 +2,7 @@
 
 Automatically generate api documentation for Laravel without writing annotations.
 
+Read more: https://medium.com/web-developer/laravel-automatically-generate-api-documentation-without-annotations-a-swagger-alternative-e0699409a59e
 
 ## Requirements
 

resources/views/index.blade.php

@@ -17,6 +17,7 @@
  <link rel="stylesheet" href="https://unpkg.com/prismjs/themes/prism-tomorrow.css" />
 
  <script src="https://unpkg.com/faker@5.5.3/dist/faker.min.js" referrerpolicy="no-referrer"></script>
+ <script src="https://unpkg.com/string-similarity@4.0.2/umd/string-similarity.min.js" referrerpolicy="no-referrer"></script>
 
  <script src="https://unpkg.com/vue-markdown@2.2.4/dist/vue-markdown.js"></script>
  <script src="https://cdnjs.cloudflare.com/ajax/libs/sql-formatter/3.1.0/sql-formatter.min.js" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
@@ -47,6 +48,7 @@
  }
  .dropdown-input, .dropdown-selected{
  width: 100%;
+ font-size:14px;
  padding: 10px 16px;
  border: 1px solid transparent;
  background: #edf2f7;
@@ -77,9 +79,9 @@
  .dropdown-item{
  display: flex;
  width: 100%;
- padding: 11px 16px;
+ padding: 2px 6px;
  cursor: pointer;
- font-size: 15;
+ font-size: 12px;
  }
  .dropdown-item:hover{
  background: #edf2f7;
@@ -96,21 +98,23 @@
  </div>
  </nav>
  <div id="app" v-cloak class="w-full flex lg:pt-10">
- <aside class="text-xl text-grey-darkest break-all bg-gray-200 pl-2 h-screen sticky top-1 overflow-auto" style="width: 25%">
+ <aside class="text-xl text-grey-darkest break-all bg-gray-200 pl-2 h-screen sticky top-1 overflow-auto" style="width: 35%">
  <h1 class="font-light mx-3">Routes List</h1>
  <div class="dropdown">
  <input
  v-model.trim="search"
- v-chang
- class="dropdown-input shadow appearance-none border rounded w-full py-2 px-3 text-gray-700 leading-tight focus:outline-none focus:shadow-outline"
+ class="dropdown-input appearance-none border rounded w-full py-2 px-3 text-gray-700 leading-tight focus:outline-none focus:shadow-outline"
  type="text"
  placeholder="Search"
  @focus="showRoute = true;$event.target.select()"
  @blur="setTimeout(() => { showRoute = false}, 200)"
  />
  <div class="dropdown-list">
  @foreach ($docs as $index => $doc)
- <div v-show="showRoute" @click="searched('{{ $doc["methods"][0] }}', '{{ $doc["uri"] }}')" class="dropdown-item">
+ <div v-if="filter('{{ $doc["uri"] }}')"
+ v-show="showRoute"
+ @click="searched('{{ $doc["methods"][0] }}', '{{ $doc["uri"] }}') ; highlightSidebar('{{ $index }}')"
+ class="dropdown-item">
  {{ str_replace('api/', '', $doc['uri']) }}
  </div>
  @endforeach
@@ -126,10 +130,10 @@ class="dropdown-input shadow appearance-none border rounded w-full py-2 px-3 tex
  <tr>
  <td>
  @if ($previousController['controller'] !== $doc['controller'])
- <h3 class="my-2 font-semibold" style="font-size: 18px">{{ str_replace('Controller', '', $doc['controller']) }}</h3>
+ <h3 class="mt-2 font-thin">{{ str_replace('Controller', '', $doc['controller']) }}</h3>
  @endif
  <a href="#{{$doc['methods'][0] .'-'. $doc['uri']}}" @click="highlightSidebar({{$index}})">
- <span class="w-20
+ <span class="
  font-thin
  inline-flex
  items-center
@@ -201,7 +205,7 @@ class="dropdown-input shadow appearance-none border rounded w-full py-2 px-3 tex
  <tbody>
  <tr>
  <td class="align-left border border-gray-300 pl-2 pr-2 bg-gray-200 font-bold">Controller</td>
- <td class="align-left border pl-2 pr-2 break-all">{{$doc['controller']}}</td>
+ <td class="align-left border pl-2 pr-2 break-all">{{$doc['controller_full_path']}}</td>
  </tr>
  <tr>
  <td class="align-left border border-gray-300 pl-2 pr-2 bg-gray-200 font-bold">Method</td>
@@ -494,6 +498,13 @@ class="my-prism-editor"
  showRoute: false
  },
  methods: {
+ filter(uri) {
+ if (!this.search) {
+ return true
+ }
+ var similarity = stringSimilarity.compareTwoStrings(uri, this.search);
+ return similarity > 0.1
+ },
  searched(method, uri) {
  var oldUrl = new URL(document.URL);
  oldUrl.hash = '#' + method + '-' + uri;
@@ -567,8 +578,12 @@ class="my-prism-editor"
  doc.queries = error.data['_lrd']['queries']
  delete error.data['_lrd']
  }
- doc.response = JSON.stringify(error.response.data, null, 2)
- doc.responseCode = error.response.status;
+ doc.loading = false
+ if (error && error.response && error.response.data) {
+ doc.response = JSON.stringify(error.response.data, null, 2)
+ doc.responseCode = error.response.status;
+ }
+
  doc.responseOk = false
  }).then(function () {
  doc.loading = false

src/LaravelRequestDocs.php

@@ -14,27 +14,27 @@ class LaravelRequestDocs
 
  public function getDocs()
  {
- $docs = [];
- $excludePatterns = config('request-docs.hide_matching') ?? [];
- $controllersInfo = $this->getControllersInfo();
- $controllersInfo = $this->appendRequestRules($controllersInfo);
- foreach ($controllersInfo as $controllerInfo) {
- try {
- $exclude = false;
- foreach ($excludePatterns as $regex) {
- $uri = $controllerInfo['uri'];
- if (preg_match($regex, $uri)) {
- $exclude = true;
- }
- }
- if (!$exclude) {
- $docs[] = $controllerInfo;
+ $docs = [];
+ $excludePatterns = config('request-docs.hide_matching') ?? [];
+ $controllersInfo = $this->getControllersInfo();
+ $controllersInfo = $this->appendRequestRules($controllersInfo);
+ foreach ($controllersInfo as $controllerInfo) {
+ try {
+ $exclude = false;
+ foreach ($excludePatterns as $regex) {
+ $uri = $controllerInfo['uri'];
+ if (preg_match($regex, $uri)) {
+ $exclude = true;
  }
- } catch (Exception $exception) {
- continue;
  }
+ if (!$exclude) {
+ $docs[] = $controllerInfo;
+ }
+ } catch (Exception $exception) {
+ continue;
  }
- return array_filter($docs);
+ }
+ return array_filter($docs);
  }
 
  public function sortDocs(array $docs, $sortBy = 'default'): Array