Merge pull request #335 from rakutentech/feature/features-for-users

Vups and new features for users

Author: kevincobain2000

.github/workflows/node.yml

@@ -10,7 +10,7 @@ jobs:
 
     strategy:
       matrix:
-        node-versions: [16, 18, 19, 20]
+        node-versions: [20]
 
     steps:
       - name: Cancel Previous Runs

.github/workflows/phptest.yml

@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        php: [7.4, 8.0, 8.1, 8.2]
+        php: [7.4, 8.0, 8.1, 8.2, 8.3]
         laravel: [8.*]
         include:
           - php: 8.0
@@ -22,6 +22,8 @@ jobs:
             laravel: 10.*
           - php: 8.2
             laravel: 10.*
+          - php: 8.3
+            laravel: 10.*
 
     name: PHP ${{ matrix.php }} - Laravel ${{ matrix.laravel }}
 

.github/workflows/releaser.yml

@@ -13,7 +13,7 @@ jobs:
 
     strategy:
       matrix:
-        node-versions: [18]
+        node-versions: [20]
 
     steps:
       - name: Cancel Previous Runs

composer.json

@@ -16,7 +16,7 @@
         }
     ],
     "require": {
-        "php": "^7.4|^8.0|^8.1|^8.2",
+        "php": "^7.4|^8.0|^8.1|^8.2|^8.3",
         "illuminate/contracts": "^8.37|^9.0|^10.0",
         "kitloong/laravel-app-logger": "^1.0",
         "spatie/laravel-package-tools": "^1.4.3",

config/request-docs.php

@@ -1,6 +1,8 @@
 <?php
 
 return [
+    // changes doc title
+    'title' => 'LRD - Laravel Request Docs',
     'enabled' => true,
     // change it to true will make lrd to throw exception if rules in request class need to be changed
     // keep it false
@@ -38,9 +40,16 @@
     'rules_methods' => [
         'rules'
     ],
+
     // Can be overridden as // @LRDresponses 200|400|401
     'default_responses' => [ "200", "400", "401", "403", "404", "405", "422", "429", "500", "503"],
 
+    // changes default headers on first load for Set Global Headers
+    // Later the local storage is used when edits are made
+    'default_headers' => [
+        'Content-Type' => 'application/json',
+    ],
+
     // By default, LRD group your routes by the first /path.
     // This is a set of regex to group your routes by prefix.
     'group_by' => [

src/Controllers/LaravelRequestDocsController.php

@@ -121,4 +121,18 @@ public function assets(Request $request)
         }
         return response()->json(['error' => 'file not found'], 404);
     }
+
+    /**
+     * @codeCoverageIgnore
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function config(Request $request)
+    {
+        $config = [
+            'title' => config('request-docs.title'),
+            'default_headers'  => config('request-docs.default_headers'),
+        ];
+        return response()->json($config);
+    }
 }

src/LaravelRequestDocsServiceProvider.php

@@ -47,6 +47,10 @@ public function packageBooted()
             ->name('request-docs.api')
             ->middleware(config('request-docs.middlewares'));
 
+        Route::get("request-docs/config", [\Rakutentech\LaravelRequestDocs\Controllers\LaravelRequestDocsController::class, 'config'])
+            ->name('request-docs.config')
+            ->middleware(config('request-docs.middlewares'));
+
         Route::get("request-docs/_astro/{slug}", [\Rakutentech\LaravelRequestDocs\Controllers\LaravelRequestDocsController::class, 'assets'])
             // where slug is either js or css
             ->where('slug', '.*js|.*css|.*png|.*jpg|.*jpeg|.*gif|.*svg|.*ico|.*woff|.*woff2|.*ttf|.*eot|.*otf|.*map')

ui/README.md

@@ -12,9 +12,9 @@ npm run dev
 
 ## 1) Mode: Readonly
 
-**Open in Browser** 
+**Open in Browser**
 
-http://localhost:3000/request-docs?api=http://localhost:3000/request-docs/sample.json
+http://localhost:3000/request-docs/?api=http://localhost:3000/request-docs/sample.json
 
 
 ## 2) Mode: Developing with Laravel via npm

ui/astro.config.mjs

@@ -1,6 +1,7 @@
 import { defineConfig } from 'astro/config'
 import compress from 'astro-compress'
 import react from '@astrojs/react'
+import process from 'process'
 
 import git from 'git-rev-sync'
 const version = git.tag()