Modern Laravel OpenAPI (Swagger) documentation generator. No PHPDoc annotations required.
MIT License
Bot releases are visible (Hide)
Published by romalytvynenko 5 months ago
Full Changelog: https://github.com/dedoc/scramble/compare/v0.10.5...v0.10.6
Published by romalytvynenko 5 months ago
additional
on anonymous collections by @romalytvynenko in https://github.com/dedoc/scramble/pull/377
Full Changelog: https://github.com/dedoc/scramble/compare/v0.10.4...v0.10.5
Published by romalytvynenko 5 months ago
Full Changelog: https://github.com/dedoc/scramble/compare/v0.10.3...v0.10.4
Published by romalytvynenko 5 months ago
Full Changelog: https://github.com/dedoc/scramble/compare/v0.10.2...v0.10.3
Published by romalytvynenko 5 months ago
Full Changelog: https://github.com/dedoc/scramble/compare/v0.10.1...v0.10.2
Published by romalytvynenko 5 months ago
Full Changelog: https://github.com/dedoc/scramble/compare/v0.10.0...v0.10.1
Published by romalytvynenko 5 months ago
@example
support to API resources' attributes by @romalytvynenko in https://github.com/dedoc/scramble/pull/342
confirmed
rule not working properly when it is used on multiple attributes by @nicolaubrasil in https://github.com/dedoc/scramble/pull/339
HEAD
and DELETE
by default by @manuel-watchenterprise in https://github.com/dedoc/scramble/pull/346
Full Changelog: https://github.com/dedoc/scramble/compare/v0.9.0...v0.10.0
Published by romalytvynenko 7 months ago
If there are any problems when running composer update dedoc/scramble
, include -W
flag to update other dependencies as well. The issue may be caused in some rare cases by php-parser
being changed to 5.0.*
from 4.0.*
.
scramble:export
command to export specification's json by @princejohnsantillan in https://github.com/dedoc/scramble/pull/277
Carbon
attributes in resources being not documented as string<date-time>
in Open API spec by @romalytvynenko in https://github.com/dedoc/scramble/pull/332
Full Changelog: https://github.com/dedoc/scramble/compare/v0.8.6...v0.9.0
Published by romalytvynenko 8 months ago
scopes
property in OAuth made required according OpenAPI spec by @Neorej in https://github.com/dedoc/scramble/pull/318
Full Changelog: https://github.com/dedoc/scramble/compare/v0.8.5...v0.8.6
Published by romalytvynenko 11 months ago
whenCounted
support in API resources by @vovarudomanenko in https://github.com/dedoc/scramble/pull/236
min
and max
rules on arrays by @Carnicero90 in https://github.com/dedoc/scramble/pull/244
Full Changelog: https://github.com/dedoc/scramble/compare/v0.8.4...v0.8.5
Published by romalytvynenko about 1 year ago
Try It
disabled and logo) by @kichetof in https://github.com/dedoc/scramble/pull/177
getRouteKeyName
on a model by @romalytvynenko in https://github.com/dedoc/scramble/pull/208
image
and file
validation rules support, request media type customization support by @WildEgo, @AlexSabur, @romalytvynenko in https://github.com/dedoc/scramble/pull/232
@response
wasn't the most prioritized by @romalytvynenko in https://github.com/dedoc/scramble/pull/205
operationId
when routes without names are cached by @romalytvynenko in https://github.com/dedoc/scramble/pull/207
Full Changelog: https://github.com/dedoc/scramble/compare/v0.8.3...v0.8.4
Published by romalytvynenko about 1 year ago
LengthAwarePaginator
annotation (LengthAwarePaginator<Post>
) by @romalytvynenko in https://github.com/dedoc/scramble/pull/175
Full Changelog: https://github.com/dedoc/scramble/compare/v0.8.2...v0.8.3
Published by romalytvynenko about 1 year ago
Scope@getType
returning unexpected null
by @romalytvynenko in https://github.com/dedoc/scramble/pull/167
Full Changelog: https://github.com/dedoc/scramble/compare/v0.8.1...v0.8.2
Published by romalytvynenko about 1 year ago
null
by @romalytvynenko in https://github.com/dedoc/scramble/pull/165
Full Changelog: https://github.com/dedoc/scramble/compare/v0.8.0...v0.8.1
Published by romalytvynenko about 1 year ago
confirmed
rule support by @romalytvynenko in https://github.com/dedoc/scramble/pull/124
operationId
support by @romalytvynenko and @HelgeSverre in https://github.com/dedoc/scramble/pull/153
Full Changelog: https://github.com/dedoc/scramble/compare/v0.7.2...v0.8.0
Published by romalytvynenko over 1 year ago
Full Changelog: https://github.com/dedoc/scramble/compare/v0.7.1...v0.7.2
Published by romalytvynenko over 1 year ago
local
env only by default and using viewApiDocs
gate in other environments by @tontonsb in https://github.com/dedoc/scramble/pull/102
declare(strict_types=1);
was used by @romalytvynenko in https://github.com/dedoc/scramble/pull/107
Full Changelog: https://github.com/dedoc/scramble/compare/v0.7.0...v0.7.1
Published by romalytvynenko almost 2 years ago
abort
, abort_if
, abort_unless
) by @romalytvynenko in https://github.com/dedoc/scramble/pull/94
JsonResource
s in the resource class, added support of 3rd argument in when
and whenLoaded
by @romalytvynenko in https://github.com/dedoc/scramble/pull/87
null
able by @romalytvynenko in https://github.com/dedoc/scramble/pull/74
@var
by @romalytvynenko in https://github.com/dedoc/scramble/pull/75
exceptions
property on possibly nullable object by @romalytvynenko in https://github.com/dedoc/scramble/pull/95
phpDoc
attributes on resolved type attached by PhpDocHandler
when they're attached to pending type by @romalytvynenko in https://github.com/dedoc/scramble/pull/96
doctrine/dbal
is not installed by @romalytvynenko in https://github.com/dedoc/scramble/pull/99
Full Changelog: https://github.com/dedoc/scramble/compare/v0.6.0...v0.7.0
Published by romalytvynenko almost 2 years ago
true
and false
expressions by @romalytvynenko in https://github.com/dedoc/scramble/pull/58
Full Changelog: https://github.com/dedoc/scramble/compare/v0.5.0...v0.6.0
Published by romalytvynenko about 2 years ago
Applicable if you've published Scramble's config or relied on the default route resolver behavior (which resolved routes by looking if a route uses api
middleware). In most cases you shouldn't really be affected by the change unless you modified API base URL.
In 0.4.0
I've introduced api_base_url
config that allowed configuring and modifying API base URL. By default it was url('/api')
. Sadly enough, using url
in config file caused php artisan serve
to fail with the following error:
Illuminate\Routing\UrlGenerator::__construct(): Argument #2 ($request) must be of type Illuminate\Http\Request, null given,
called in /***/vendor/laravel/framework/src/Illuminate/Routing/RoutingServiceProvider.php on line
67
To fix the issue I decided to go away from the idea of using url
helper in config and instead, and introduced api_path
config. So now this part of the config is much simpler and looks like 'api_path' => 'api'
.
Also, the default behavior of the default routes resolver changed as well. Previously it took all the routes that were using api
middleware. From now on, by default all the routes which URL starts with api/
(scramble.api_path
) will be used.
Full Changelog: https://github.com/dedoc/scramble/compare/v0.4.0...v0.5.0