Laravel Apidoc Generator Laravel Package

Added

• Support @hideFromAPIDocumentation on controllers. (https://github.com/mpociot/laravel-apidoc-generator/pull/745)
• Allow strategies to return null. (https://github.com/mpociot/laravel-apidoc-generator/pull/739)

Added

• Support for Laravel Vapor. (https://github.com/mpociot/laravel-apidoc-generator/pull/729)
• Allow customization of static output path. (https://github.com/mpociot/laravel-apidoc-generator/pull/730)

Added

• Allow [@authenticated](https://github.com/authenticated) to be set at controller level. (https://github.com/mpociot/laravel-apidoc-generator/pull/726)

Fixed

• Fix version constraint...again. (https://github.com/mpociot/laravel-apidoc-generator/pull/725)

Fixed

• Fix version constraints preventing installation on some Laravel 7 installations.

Fixed

• Fixed link to Postman connection in docs when Laravel autoload is used (https://github.com/mpociot/laravel-apidoc-generator/pull/714)

Fixed

• Fixed double json encode when fetching collection in Laravel type docs (https://github.com/mpociot/laravel-apidoc-generator/pull/713)

Added

• Support for body params as array (https://github.com/mpociot/laravel-apidoc-generator/pull/710)

Fixed

• Array query params can now be used and render properly (https://github.com/mpociot/laravel-apidoc-generator/pull/700)

Changed

• Updated Documentarian dependency for Laravel v7 (https://github.com/mpociot/laravel-apidoc-generator/pull/699)

Changed

• Updated nunomaduro/collision to include v4 (https://github.com/mpociot/laravel-apidoc-generator/pull/699)

Fixed

• Use correct protocol for Postman collcetion URL (https://github.com/mpociot/laravel-apidoc-generator/pull/697)

Fixed

• Shim URL::formatRoot() on Lumen (https://github.com/mpociot/laravel-apidoc-generator/pull/688)

Changed

• Made "Skipping route" message more descriptive (https://github.com/mpociot/laravel-apidoc-generator/commit/6f61469a9fa8be30e7812cf622a7832163a08bb8)

Fixed

• Set a default value for the routematcher when fetching from config (https://github.com/mpociot/laravel-apidoc-generator/pull/677)

Fixed

• Fixed autogenerated docs endpoint address for Postman collection (https://github.com/mpociot/laravel-apidoc-generator/pull/673)

Added

• New Postman collection generation features (https://github.com/mpociot/laravel-apidoc-generator/pull/666):
  • Properly handle url parameters using the :param syntax (opposed to the Laravel-esque {param} syntax)
  • Allow configuring the auth section of Postman collection config
  • Add some documentation that was available but not exported in the Postman collection (for URL params and query params)

Changed

• The package can now create a documentation endpoint automatically for laravel-type routes. This also allows users to install the package on dev-only enviornments but have their routes available in others, without writing custom routing code. (https://github.com/mpociot/laravel-apidoc-generator/pull/659)

Fixed

• Error when installing due to DI not working properly on constructor (https://github.com/mpociot/laravel-apidoc-generator/pull/672)

Added

• RouteMatcher to use can now be specified by user (https://github.com/mpociot/laravel-apidoc-generator/pull/657)

Fixed

• Also copy custom logo for non-static docs (https://github.com/mpociot/laravel-apidoc-generator/commit/720f9c9e9b2443bcfb474b959febaf6cf5c3f004)

Fixed

• Fixed missing body parameters in response calls (https://github.com/mpociot/laravel-apidoc-generator/commit/5d9371c14391485630941c718d7f168afd540126)
• Add slashes to header values in bash templates to escape special chars (https://github.com/mpociot/laravel-apidoc-generator/commit/e693d746b1c1daf342c28e53daa8f7b34ce9da2b)
• Fixed iteration over null bug - set responses to empty array (https://github.com/mpociot/laravel-apidoc-generator/commit/a24b1e14b17ade8fb4aa1534448904e1075b004c)

Fixed

• Update rebuild command to work with new docs locations (https://github.com/mpociot/laravel-apidoc-generator/pull/646)

Added

• Added headers stage (https://github.com/mpociot/laravel-apidoc-generator/pull/624)
• Support for non-static docs, changed source files locations (https://github.com/mpociot/laravel-apidoc-generator/pull/608)
• Support for Eloquent API resources (https://github.com/mpociot/laravel-apidoc-generator/pull/601)
• bindings replaced by [@urlParam](https://github.com/urlParam) annotation (https://github.com/mpociot/laravel-apidoc-generator/pull/599)
• Better support for arrays and objects in bodyParams (https://github.com/mpociot/laravel-apidoc-generator/pull/597)

Modified

• Postman collection now have the body as raw instead of formdata. (https://github.com/mpociot/laravel-apidoc-generator/pull/627)
• Nonexistent [@responseFile](https://github.com/responseFile) annotations now show a warning and skip the route (https://github.com/mpociot/laravel-apidoc-generator/pull/620)
• Use symfony/var-exporter to export PHP arrays, ensuring short array syntax (https://github.com/mpociot/laravel-apidoc-generator/pull/615)
• Use single quotes in PHP example template (https://github.com/mpociot/laravel-apidoc-generator/pull/612)
• Transformer annotations are now given priority over all other response strategies (https://github.com/mpociot/laravel-apidoc-generator/pull/620)
• Made ResponseCalls strategy only execute if no successful responses exist. (https://github.com/mpociot/laravel-apidoc-generator/pull/605)
• Hide null responses in examples. (https://github.com/mpociot/laravel-apidoc-generator/pull/605)
• Made responses stage additive (https://github.com/mpociot/laravel-apidoc-generator/pull/605)
• Renamed query and body in response_calls config to queryParams and bodyParams (https://github.com/mpociot/laravel-apidoc-generator/pull/603)

Removed

• Removed apply.response_calls.headers in favour of apply.headers (https://github.com/mpociot/laravel-apidoc-generator/pull/603)
• Removed bindings in response_calls (https://github.com/mpociot/laravel-apidoc-generator/pull/599)

Fixed

• ResponseCalls: Call Lumen application correctly since it does not use HttpKernel (https://github.com/mpociot/laravel-apidoc-generator/pull/585)
• Update usage of clean*Parameters in python template (https://github.com/mpociot/laravel-apidoc-generator/commit/02fb719d0d6c25e6ce72f30dc8b9604449061156)
• Bugfix: really exclude parameters from examples, not just send empty strings (https://github.com/mpociot/laravel-apidoc-generator/commit/762e2e1003d389d6e785d31144eca89c40515926, https://github.com/mpociot/laravel-apidoc-generator/commit/e54b474578b53f97f4737664a63131b315aaf82d)

Added

• Switched to a plugin architecture that allows support for external strategies (https://github.com/mpociot/laravel-apidoc-generator/pull/570)

Changed

• Exclude Laravel Telescope routes when present (https://github.com/mpociot/laravel-apidoc-generator/pull/579)
• Set status code for transformer response from tag if present (https://github.com/mpociot/laravel-apidoc-generator/pull/581)
• Set status code for response call from actual response (https://github.com/mpociot/laravel-apidoc-generator/pull/581)

Fixed

• Removed references to removed helper functions in 6.0 (https://github.com/mpociot/laravel-apidoc-generator/pull/576)

Fixed

• Support for Laravel 6 (https://github.com/mpociot/laravel-apidoc-generator/commit/f7dd8d19b75755763e8e20ab4025075eba5cd51a)

Added

• Use HTTPS in Postman collection if base_url is HTTPS (https://github.com/mpociot/laravel-apidoc-generator/pull/575)

Added

• Support for Laravel 6 (https://github.com/mpociot/laravel-apidoc-generator/pull/572)

Modified

• Postman collections and URLs in example requests now use the apidoc.base_url config variable (https://github.com/mpociot/laravel-apidoc-generator/pull/523)

Added

• Support for PHP array callable syntax in route action (https://github.com/mpociot/laravel-apidoc-generator/pull/516)

Fixed

• Added faker_seed (https://github.com/mpociot/laravel-apidoc-generator/commit/d2901e51a68c17066d4dd96054ff5bfdf124945b)

Added

• Support for URL paths in include/exclude rules (https://github.com/mpociot/laravel-apidoc-generator/pull/507)

Fixed

• Handle exception for no URL::forceRootURL() method in Lumen (https://github.com/mpociot/laravel-apidoc-generator/commit/2146fa114dc18bc32c00b5c5550266d753d5aef3)
• Url parameter bindings (https://github.com/mpociot/laravel-apidoc-generator/commit/f0dc118c6b7792894bf9baa352d7fc4ca8ca74b5)

Added

• Support for [@queryParams](https://github.com/queryParams) in Dingo FormRequests (https://github.com/mpociot/laravel-apidoc-generator/pull/506)
• Easier customisation of example languages (https://github.com/mpociot/laravel-apidoc-generator/commit/0aa737a2e54a913eab4d024a1644c5ddd5dee8b8)
• Include PHP as example language (https://github.com/mpociot/laravel-apidoc-generator/commit/c5814762fa52095fe645716554839b6ae110ef89)

Added

• Support for [@queryParams](https://github.com/queryParams) in FormRequests (https://github.com/mpociot/laravel-apidoc-generator/pull/504)
• Added default_group key to replace ungrouped_name (https://github.com/mpociot/laravel-apidoc-generator/commit/72b5f546c1b84e69fe43c720a04f448c3b96e345)

Added

• Option to seed faker for deterministic output (https://github.com/mpociot/laravel-apidoc-generator/pull/503)
• Support for binding prefixes (https://github.com/mpociot/laravel-apidoc-generator/pull/498)
• Ability to override Laravel config (https://github.com/mpociot/laravel-apidoc-generator/pull/496)
• Allow override of the name 'general' for ungrouped routes (https://github.com/mpociot/laravel-apidoc-generator/pull/491)

Changed

• Use parameter-bound URL in doc examples (https://github.com/mpociot/laravel-apidoc-generator/pull/500)

Fixed

• Request router now matches when router has sub-domain (https://github.com/mpociot/laravel-apidoc-generator/pull/493)

Fixed

• Allow users specify custom Content-type header for Markdown examples (https://github.com/mpociot/laravel-apidoc-generator/pull/486)

Fixed

• Ignore scalar type hints when checking for FormRequests (https://github.com/mpociot/laravel-apidoc-generator/pull/474)

Added

• Ability to set cookies on response calls (https://github.com/mpociot/laravel-apidoc-generator/pull/471)

Fixed

• Support for Lumen 5.7 (https://github.com/mpociot/laravel-apidoc-generator/pull/467)

Added

• Support for Laravel 5.8 (https://github.com/mpociot/laravel-apidoc-generator/pull/462)
• Ability to annotate body parameters on FormRequest (https://github.com/mpociot/laravel-apidoc-generator/pull/460)

Added

• Ability to specify array and object body/query params using dot notation (https://github.com/mpociot/laravel-apidoc-generator/pull/445)
• Ability to specify name and description of Postman collection (https://github.com/mpociot/laravel-apidoc-generator/pull/443)

Fixed

• Postman collection and documentation base URL now uses config('app.url') (https://github.com/mpociot/laravel-apidoc-generator/pull/458)

Fixed

• Fixed vendor tags (https://github.com/mpociot/laravel-apidoc-generator/pull/444)

Added

• Ability to replace json key values in response file (https://github.com/mpociot/laravel-apidoc-generator/pull/434)
• Support for custom transfer serializers (https://github.com/mpociot/laravel-apidoc-generator/pull/441)

Changed

• API groups are now sorted "naturally" (https://github.com/mpociot/laravel-apidoc-generator/pull/428)

Fixed

• Partial resource controllers are now properly supported (https://github.com/mpociot/laravel-apidoc-generator/pull/429)
• PUT request body now formatted as urlencoded in Postman collection (https://github.com/mpociot/laravel-apidoc-generator/pull/418)
• [@responseFile](https://github.com/responseFile) strategy now properly renders responses (https://github.com/mpociot/laravel-apidoc-generator/pull/427)

Added

• Ability to exclude a query or body parameter from being included in the example requests (https://github.com/mpociot/laravel-apidoc-generator/pull/552)

Fixed

• Backwards compatibility for the changes to [@group](https://github.com/group) introduced in 3.12.0 (https://github.com/mpociot/laravel-apidoc-generator/commit/5647eda35ebb7f8aed35b31790c5f220b736e985)

Fixed

• Specifying an [@group](https://github.com/group) for a method no longer requires you to add the description. (https://github.com/mpociot/laravel-apidoc-generator/pull/556)
• Pass the verbosity level down to the Collision library. (https://github.com/mpociot/laravel-apidoc-generator/pull/556)

Added

• Support for query parameters in the bash template (https://github.com/mpociot/laravel-apidoc-generator/pull/545)
• Include query parameters and headers in the generated Postman collection (https://github.com/mpociot/laravel-apidoc-generator/pull/537)
• Include Python out of the box as example language (https://github.com/mpociot/laravel-apidoc-generator/pull/524)

Changed

• Moved nunomaduro/collision to "suggested" so it doesn't break PHP 7.0 (https://github.com/mpociot/laravel-apidoc-generator/commit/2f3a2144e1a4f1eb0229aea8b4d11707cb4aabbf)

Fixed

• Stopped using config helper inside config file (https://github.com/mpociot/laravel-apidoc-generator/pull/548)

Added

• Ability to specify different responses for different status codes. (https://github.com/mpociot/laravel-apidoc-generator/pull/416)

Added

• --verbose flag to show exception encountered when making response calls (https://github.com/mpociot/laravel-apidoc-generator/commit/dc987f296e5a3d073f56c67911b2cb61ae47e9dc)

Added

• Add ResponseFileStrategy to retrieve responses from files. (https://github.com/mpociot/laravel-apidoc-generator/pull/410)

Modified

• Switch from jQuery to fetch in JavaScript examples. (https://github.com/mpociot/laravel-apidoc-generator/pull/411)

Added

• include and exclude route options now support wildcards (https://github.com/mpociot/laravel-apidoc-generator/pull/409)

Fixed

• Make router option case-insensitive (https://github.com/mpociot/laravel-apidoc-generator/pull/407)

Fixed

• Replaced use of Storage::copy with PHP's copy to work with absolute paths (https://github.com/mpociot/laravel-apidoc-generator/pull/404)

Fixed

• Replaced use of config_path with more generic option for better Lumen compatibility (https://github.com/mpociot/laravel-apidoc-generator/pull/398)

Added

• Ability to specify examples for body and query parameters (https://github.com/mpociot/laravel-apidoc-generator/pull/394)

Fixed

• Rendering of example requests' descriptions (https://github.com/mpociot/laravel-apidoc-generator/pull/393)

Fixed

• Rendering of query parameters' descriptions (https://github.com/mpociot/laravel-apidoc-generator/pull/387)

Added

• Official Lumen support (https://github.com/mpociot/laravel-apidoc-generator/pull/382)
• [@queryParam](https://github.com/queryParam) annotation (https://github.com/mpociot/laravel-apidoc-generator/pull/383)
• [@bodyParam](https://github.com/bodyParam) annotation (https://github.com/mpociot/laravel-apidoc-generator/pull/362, https://github.com/mpociot/laravel-apidoc-generator/pull/366)
• [@authenticated](https://github.com/authenticated) annotation (https://github.com/mpociot/laravel-apidoc-generator/pull/369)
• Ability to override the controller [@group](https://github.com/group) from the method. (https://github.com/mpociot/laravel-apidoc-generator/pull/372)
• Ability to use a custom logo (https://github.com/mpociot/laravel-apidoc-generator/pull/368)

Changed

• Moved from command-line options to a config file (https://github.com/mpociot/laravel-apidoc-generator/pull/362)
• Commands have been renamed to the apidoc namespace (previously api). (https://github.com/mpociot/laravel-apidoc-generator/pull/350)
• The update command has been renamed to rebuild and now uses the output path configured in the config file. (https://github.com/mpociot/laravel-apidoc-generator/pull/370)
• [@resource](https://github.com/resource) renamed to [@group](https://github.com/group) (https://github.com/mpociot/laravel-apidoc-generator/pull/371)
• Added more configuration options for response calls (https://github.com/mpociot/laravel-apidoc-generator/pull/377)

Fixed

Removed

• FormRequest parsing is no longer supported (https://github.com/mpociot/laravel-apidoc-generator/pull/362)