Skip to content

Fix incorrect URLs generated for "Try it" feature #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DenTray merged 5 commits into from
Jan 22, 2025
Merged

Fix incorrect URLs generated for "Try it" feature #153

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c8d98cf
Update SwaggerService.php
hans-thomas Jan 15, 2025
54ab9c4
Update tests;
hans-thomas Jan 15, 2025
fd8f8d4
Add test to cover the new line;
hans-thomas Jan 15, 2025
c041efe
Making suggested changes;
hans-thomas Jan 21, 2025
4bc635f
Update src/Traits/GetDependenciesTrait.php
DenTray Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions src/Services/SwaggerService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
use Illuminate\Http\Request;
use Illuminate\Http\Testing\File;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\URL;
use Illuminate\Support\Str;
use ReflectionClass;
use RonasIT\AutoDoc\Exceptions\DocFileNotExistsException;
Expand Down Expand Up @@ -140,7 +141,7 @@ protected function generateEmptyData(): array
$data = [
'openapi' => self::OPEN_API_VERSION,
'servers' => [
['url' => $this->getAppUrl() . $this->config['basePath']],
['url' => URL::query($this->config['basePath'])],
],
'paths' => [],
'components' => [
Expand All @@ -158,13 +159,6 @@ protected function generateEmptyData(): array
return $data;
}

protected function getAppUrl(): string
{
$url = config('app.url');

return str_replace(['http://', 'https://', '/'], '', $url);
}

protected function generateSecurityDefinition(): ?array
{
if (empty($this->security)) {
Expand Down
2 changes: 1 addition & 1 deletion src/Traits/GetDependenciesTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ protected function transformDependency(ReflectionParameter $parameter)
{
$type = $parameter->getType();

if (empty($type)) {
if (empty($type) || !$type instanceof \ReflectionNamedType) {
return null;
}

Expand Down
2 changes: 1 addition & 1 deletion tests/fixtures/SwaggerServiceTest/tmp_data_get_route_parameters_description.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.1.0",
"servers": [
{
"url": "localhost/"
"url": "http://localhost"
}
],
"paths": {
Expand Down
2 changes: 1 addition & 1 deletion tests/fixtures/SwaggerServiceTest/tmp_data_request_with_empty_data_and_info.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.1.0",
"servers": [
{
"url": "localhost/"
"url": "http://localhost"
}
],
"paths": [],
Expand Down
2 changes: 1 addition & 1 deletion tests/fixtures/SwaggerServiceTest/tmp_data_request_with_empty_data_jwt.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.1.0",
"servers": [
{
"url": "localhost/"
"url": "http://localhost"
}
],
"paths": [],
Expand Down
2 changes: 1 addition & 1 deletion tests/fixtures/SwaggerServiceTest/tmp_data_request_with_empty_data_laravel.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.1.0",
"servers": [
{
"url": "localhost/"
"url": "http://localhost"
}
],
"paths": [],
Expand Down
2 changes: 1 addition & 1 deletion tests/fixtures/SwaggerServiceTest/tmp_data_request_with_empty_data_query.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.1.0",
"servers": [
{
"url": "localhost/"
"url": "http://localhost"
}
],
"paths": [],
Expand Down
2 changes: 1 addition & 1 deletion tests/fixtures/SwaggerServiceTest/tmp_data_search_roles_closure_request.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.1.0",
"servers": [
{
"url": "localhost/"
"url": "http://localhost"
}
],
"paths": {
Expand Down
2 changes: 1 addition & 1 deletion tests/fixtures/SwaggerServiceTest/tmp_data_search_roles_request.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.1.0",
"servers": [
{
"url": "localhost/"
"url": "http://localhost"
}
],
"paths": {
Expand Down
2 changes: 1 addition & 1 deletion tests/fixtures/SwaggerServiceTest/tmp_data_search_roles_request_jwt_security.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.1.0",
"servers": [
{
"url": "localhost/"
"url": "http://localhost"
}
],
"paths": {
Expand Down
2 changes: 1 addition & 1 deletion tests/fixtures/SwaggerServiceTest/tmp_data_search_roles_request_laravel_security.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.1.0",
"servers": [
{
"url": "localhost/"
"url": "http://localhost"
}
],
"paths": {
Expand Down
2 changes: 1 addition & 1 deletion tests/fixtures/SwaggerServiceTest/tmp_data_search_roles_request_query_security.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.1.0",
"servers": [
{
"url": "localhost/"
"url": "http://localhost"
}
],
"paths": {
Expand Down
Loading