- How do I install Filament OpenAPI Docs in a Laravel app?
- Install the package with Composer using alexkramse/filament-openapi-docs, then register the plugin in your Filament panel provider. The release ships compiled front-end assets, so you may need to publish assets depending on your deployment setup. It is intended for Laravel applications already using Filament and Scramble.
- Does Filament OpenAPI Docs support multiple API versions?
- Yes, v1.0.4 adds a version-resolution layer with versions() driving an in-page selector and version() producing a dedicated page bound to one API version. Named Scramble APIs are auto-discovered, and legacy single-generator behavior is preserved. Multi-version support is opt-in, so existing single-generator configurations should continue rendering unchanged.
- Which Laravel, PHP, Filament, and Scramble versions are supported?
- The provided release notes do not publish a version matrix, so confirm compatibility against your Composer constraints and the package README before upgrading. Pay particular attention to your Filament major version because the Filament v3 to v4 transition is decisive, and verify the Scramble major you use. Treat this as a pre-upgrade check rather than assuming support from the patch-level release alone.
- How are named Scramble APIs discovered, and what happens if none exist?
- Version discovery is automatic for named Scramble APIs, but the release notes do not specify whether discovery uses a config key, service container tag, or filesystem scan. Test the failure mode when zero or one named API exists, and confirm behavior for unnamed or partially configured generators. Run those checks in a non-production panel before relying on versioning.
- Do versioned docs pages inherit Filament panel authentication and middleware?
- The release notes do not state this explicitly, so verify whether generated per-version routes inherit the panel's auth and middleware stack by default. If they do not, attach authorization explicitly because docs pages can expose the full API surface. Check route slugs, naming, and middleware against existing panel routes before promoting versioned pages.
- Will upgrading from 1.0.x to 1.0.4 break my existing docs page?
- The release declares no breaking changes, deprecations, or removals, and existing single-generator configurations should continue rendering unchanged. The versions() and version() features are opt-in. Recommended upgrade path is to bump the constraint, republish compiled assets, smoke-test the existing docs page, then introduce versioning in a non-production panel.
- Do I need to republish compiled assets after upgrading Filament OpenAPI Docs?
- Because front-end assets changed and the release includes an npm run build step, consumers who publish assets may hold stale builds after upgrading. Republish the package assets as part of your deployment and verify the process is idempotent. Then smoke-test the docs page for visual or link changes caused by new version labels.
- Can I use Filament OpenAPI Docs without Scramble?
- No, this package is a presentation layer over Scramble-generated OpenAPI specifications rather than a generator itself. If Scramble is already producing specs for CI or client SDKs, this plugin adds a native Filament browsing and testing surface. If Scramble is not adopted yet, sequence the generator first instead of using this package as the reason to adopt it.
- How should I test and deploy multi-version API docs safely in production?
- Introduce versioning in a non-production panel first, then verify dedicated per-version route slugs, naming, and middleware against your existing panel routes. Confirm authorization prevents unintended API surface exposure and assess caching for large specifications rendered across multiple versions. The release reports 72 passing tests plus a formatter pass, but the provided context does not confirm CI beyond the author's local Pest, Pint, and build run.
- What alternatives exist for rendering OpenAPI docs in Laravel?
- Alternatives include Scramble's own documentation UI, Swagger UI or Redoc served as static pages, and hosted documentation tools. Choose Filament OpenAPI Docs when you already run Filament with Scramble and want browsing plus endpoint testing inside the admin panel. If you need a standalone public API reference, a dedicated docs renderer may fit better.