Weave Code
Swaggervel Laravel Package
appointer/swaggervel
Swaggervel integrates Swagger UI and swagger-php with Laravel, letting you generate and browse interactive API documentation from annotations. Publish the config, scan your app, and serve live API docs from a route.
Swaggervel brings Swagger/OpenAPI documentation to Laravel by integrating swagger-php with a ready-to-use Swagger UI. It scans annotated controllers and routes, generates the API specification, and serves interactive documentation directly from your application.
- Generates Swagger JSON from PHP annotations
- Bundled Swagger UI for browsing and testing endpoints
- Artisan command to rebuild documentation
- Configurable scan paths and output location
- Integrates with Laravel routing and middleware
Frequently asked questions about Swaggervel
- What is appointer/swaggervel used for?
- Swaggervel is a legacy Laravel package that serves Swagger UI and generates OpenAPI documentation for your API, typically from annotations. It was designed to give Laravel applications an interactive documentation interface with minimal setup. In modern projects, treat it as a documentation aid for existing legacy Laravel services rather than a strategic API contract tool.
- How do I install appointer/swaggervel in a Laravel app?
- Install it with Composer using composer require appointer/swaggervel, then publish its configuration and Swagger UI assets with Laravel's vendor:publish command. You then configure the annotation paths and documentation route in the published config. Validate the install in a disposable branch because the package's 2019-era dependencies may not resolve on modern Laravel or PHP versions.
- Does appointer/swaggervel support Laravel 10 or Laravel 11?
- Likely no. The package was last released in 2019 and is archived, and the assessment places it in the Laravel 5/6 era. Modern Laravel versions and newer PHP runtimes are likely to hit dependency conflicts or service-provider and asset assumptions that no longer hold. Test Composer resolution in a branch before assuming compatibility.
- Is appointer/swaggervel still maintained?
- No, appointer/swaggervel is archived and has no active upstream maintenance or security patch stream. Any fixes, dependency pinning, and compatibility work become your team's responsibility. Use it only as a time-boxed discovery aid for legacy APIs.
- How does Swaggervel generate API documentation?
- It typically relies on swagger-php annotations in your Laravel code and serves the generated spec through Swagger UI. The assessment flags uncertainty about whether the output is Swagger 2.0 or OpenAPI 3.x, so inspect the generated artifact before depending on it. Route introspection or manual config may also influence what appears in the docs.
- Can I use Swaggervel in production?
- Not recommended as a production dependency for new or upgraded Laravel platforms. The archived status means no security patches, and generated docs can expose internal routes or drift from actual API behavior. If used at all, isolate generation from production runtime and avoid making the package a deployment gate.
- What are the best alternatives to Swaggervel for Laravel?
- For maintained Laravel documentation generators, evaluate dedoc/scramble and knuckleswtf/scribe, or adopt a contract-first OpenAPI workflow. These are better fits for modern Laravel and can generate or validate OpenAPI specs without relying on archived code. Compare annotation support, OpenAPI 3.x output, and CI integration before choosing.
- How do I migrate from Swaggervel to a maintained OpenAPI tool?
- Export the Swaggervel-generated spec, normalize it to OpenAPI 3.x, and compare it against routes, tests, or observed traffic. Then replace the package with a maintained generator such as Scramble or Scribe, or move to a contract-first process. Keep the exported spec version-controlled and assign an owner for accuracy.
- Can Swaggervel run in CI to generate or validate API docs?
- It may be possible in a pinned legacy environment, but CI use is risky because dependencies are stale and generation can become flaky. The assessment recommends time-boxing any spike and avoiding runtime dependency changes in CI. If you need reliable docs builds, migrate to a maintained OpenAPI toolchain first.
- What causes Swaggervel dependency or annotation errors after a Laravel upgrade?
- Common causes include Composer constraints on PHP, Laravel, or swagger-php, plus annotation syntax changes and service-provider assumptions from older Laravel versions. Missing or stale Swagger UI assets and route middleware changes can also break generation or rendering. Roll back the upgrade, pin compatible versions in a branch, and plan migration rather than patching indefinitely.
Weaver
How can I help you explore Laravel packages today?