Skip to content

Commit d7cf031

Browse files
added /request-docs/config
1 parent 93a0606 commit d7cf031

File tree

7 files changed

+30
-5
lines changed

7 files changed

+30
-5
lines changed

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
}
1717
],
1818
"require": {
19-
"php": "^7.4|^8.0|^8.1|^8.2",
19+
"php": "^7.4|^8.0|^8.1|^8.2|^8.3",
2020
"illuminate/contracts": "^8.37|^9.0|^10.0",
2121
"kitloong/laravel-app-logger": "^1.0",
2222
"spatie/laravel-package-tools": "^1.4.3",

config/request-docs.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@
4040
],
4141
// Can be overridden as // @LRDresponses 200|400|401
4242
'default_responses' => [ "200", "400", "401", "403", "404", "405", "422", "429", "500", "503"],
43+
'default_headers' => [
44+
'Content-Type' => 'application/json',
45+
],
4346

4447
// By default, LRD group your routes by the first /path.
4548
// This is a set of regex to group your routes by prefix.

src/Controllers/LaravelRequestDocsController.php

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,4 +121,18 @@ public function assets(Request $request)
121121
}
122122
return response()->json(['error' => 'file not found'], 404);
123123
}
124+
125+
/**
126+
* @codeCoverageIgnore
127+
* @param \Illuminate\Http\Request $request
128+
* @return \Illuminate\Http\JsonResponse
129+
*/
130+
public function config(Request $request)
131+
{
132+
$config = [
133+
'default_responses' => config('request-docs.default_responses'),
134+
'default_headers' => config('request-docs.default_headers'),
135+
];
136+
return response()->json($config);
137+
}
124138
}

src/LaravelRequestDocsServiceProvider.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ public function packageBooted()
4747
->name('request-docs.api')
4848
->middleware(config('request-docs.middlewares'));
4949

50+
Route::get("request-docs/config", [\Rakutentech\LaravelRequestDocs\Controllers\LaravelRequestDocsController::class, 'config'])
51+
->name('request-docs.config')
52+
->middleware(config('request-docs.middlewares'));
53+
5054
Route::get("request-docs/_astro/{slug}", [\Rakutentech\LaravelRequestDocs\Controllers\LaravelRequestDocsController::class, 'assets'])
5155
// where slug is either js or css
5256
->where('slug', '.*js|.*css|.*png|.*jpg|.*jpeg|.*gif|.*svg|.*ico|.*woff|.*woff2|.*ttf|.*eot|.*otf|.*map')

ui/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ npm run dev
1212

1313
## 1) Mode: Readonly
1414

15-
**Open in Browser**
15+
**Open in Browser**
1616

17-
http://localhost:3000/request-docs?api=http://localhost:3000/request-docs/sample.json
17+
http://localhost:3000/request-docs/?api=http://localhost:3000/request-docs/sample.json
1818

1919

2020
## 2) Mode: Developing with Laravel via npm

ui/astro.config.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { defineConfig } from 'astro/config'
22
import compress from 'astro-compress'
33
import react from '@astrojs/react'
4+
import process from 'process'
45

56
import git from 'git-rev-sync'
67
const version = git.tag()

ui/tsconfig.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
{
2-
"extends": "astro/tsconfigs/strict"
3-
}
2+
"extends": "astro/tsconfigs/strict",
3+
"compilerOptions": {
4+
"jsx": "react"
5+
}
6+
}

0 commit comments

Comments
 (0)