- How do I install ovac/idoc in a Laravel application?
- Install it with Composer, publish the package config, and run the provided Artisan command to generate the OpenAPI document and documentation UI. The evaluation describes this as low-friction setup: a Composer require, config publish, and a single Artisan invocation. Many teams will likely add it as a require-dev dependency and generate docs in CI.
- Which Laravel and PHP versions does ovac/idoc support?
- The provided overview does not list exact Laravel and PHP version constraints. The technical evaluation explicitly flags current and next Laravel majors, plus active CI coverage, as questions to verify before adoption. Check the package composer.json and CI matrix before committing, especially if you run Laravel 10, 11, or 12.
- How does ovac/idoc infer request bodies and response schemas?
- It works code-first, inspecting your Laravel route table and controller metadata or annotations to emit an OpenAPI 3.0 document. Spec quality depends heavily on how much intent it can infer from typed FormRequests, API Resources, and conventional REST controllers. Dynamic responses, response macros, custom serializers, traits, and container-resolved dispatch may produce plausible but incomplete schemas.
- Does ovac/idoc support Sanctum, Passport, or OAuth2 security schemes?
- The provided material does not confirm built-in support for Sanctum, Passport, OAuth2, multiple servers, or per-environment base URLs. The evaluation lists these as key questions to verify, particularly because middleware-driven auth schemes can be hard to resolve through static analysis. Test the generated security definitions against your actual auth setup before relying on them.
- Can I run ovac/idoc in CI to generate a deterministic OpenAPI spec?
- The package exposes Artisan entrypoints, so non-interactive CI generation is a reasonable expectation, but the provided overview does not confirm deterministic output or stable key ordering. The evaluation recommends generating in a branch and reviewing a structural diff for endpoint coverage, missing schemas, and auth declarations. Verify repeatable output before making CI diffs a gate.
- Is ovac/idoc a good alternative to Scramble, Scribe, or L5-Swagger?
- It overlaps significantly with those tools rather than complementing them, so treat it as a candidate replacement, not an addition. The evaluation notes 185 stars, placing it well behind category leaders, and recommends comparing accuracy and maintenance before switching. Run it against your existing authoritative spec to measure coverage gaps.
- What happens when ovac/idoc cannot infer a route or schema?
- The provided material does not document the fallback behavior, so verify whether it fails loudly, skips the route, or emits a permissive any schema. This matters because a wrong or overly permissive spec can mislead SDK generators and partner integrations. Test unresolvable routes, magic __call routes, and polymorphic payloads during discovery.
- How should I secure or disable the interactive docs UI in production?
- The interactive UI reveals your route inventory and auth surface, so gate it by environment rather than relying only on authentication. The evaluation recommends environment-gating as a requirement, not an optional hardening step. Also check whether the UI can be disabled independently of spec generation, since that specific configuration detail is not confirmed in the overview.
- Does ovac/idoc handle API versioning, route prefixes, and excluded internal routes?
- The provided overview does not specify how API versioning, route prefixes, or excluded internal routes are handled. The evaluation lists these as key questions, so review the config and annotation options before rollout. Plan to validate that internal or admin routes are excluded from the published spec.
- Is ovac/idoc actively maintained and safe for production adoption?
- The evaluation flags maintainer and vendor risk as high: 185 stars, a composite score around 17, and a single visible release date are signals to investigate. Check release cadence, open-issue ratio, response time, and whether there is more than one significant contributor over the last 12 months. MIT licensing means you can fork if needed, but you must be prepared to own maintenance.