Skip to content

Commit 54399c0

Browse files
authored
Fix api docs (#908)
1 parent a520b3f commit 54399c0

File tree

6 files changed

+83
-82
lines changed

6 files changed

+83
-82
lines changed

app/Http/Controllers/ApiDocsController.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@
99

1010
class ApiDocsController extends Controller
1111
{
12-
#[Get('/api-docs', name: 'api-docs')]
12+
#[Get('/api/docs', name: 'api.docs')]
1313
public function index(): BinaryFileResponse
1414
{
1515
return response()->file(public_path('api-docs/index.html'));
1616
}
1717

18-
#[Get('/api.yaml', name: 'api-docs.api-yaml')]
18+
#[Get('/api.yaml', name: 'api-yaml')]
1919
public function apiYaml(): Response
2020
{
2121
$apiOrder = [

composer.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
"opcodesio/log-viewer": "^3.17",
2424
"phpseclib/phpseclib": "3.0.43",
2525
"spatie/laravel-route-attributes": "^1.24",
26+
"symfony/yaml": "^7.3",
2627
"tightenco/ziggy": "^2.5"
2728
},
2829
"require-dev": {

composer.lock

Lines changed: 77 additions & 77 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

public/api-docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
<script src="/api-docs/swagger-ui/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
3636
<script>
3737
const ui = SwaggerUIBundle({
38-
url: '/api-docs/api.yaml',
38+
url: '/api.yaml',
3939
dom_id: '#swagger-ui',
4040
deepLinking: true,
4141
presets: [

resources/js/pages/api-keys/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export default function ApiKeys() {
2121
<div className="flex items-start justify-between">
2222
<Heading title="API Keys" description="Here you can manage API keys" />
2323
<div className="flex items-center gap-2">
24-
<a href="/api-docs" target="_blank">
24+
<a href="/api/docs" target="_blank">
2525
<Button variant="outline">
2626
<BookOpenIcon />
2727
Docs

tests/Feature/ApiDocsTest.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ class ApiDocsTest extends TestCase
1111

1212
public function test_api_docs_endpoint_returns_html_documentation(): void
1313
{
14-
$response = $this->get('/api-docs');
14+
$response = $this->get('/api/docs');
1515

1616
$response->assertSuccessful();
1717
$response->assertHeader('content-type', 'text/html; charset=UTF-8');

0 commit comments

Comments
 (0)