DerManoMann / openapi-introspector / 39708298653

98%

push

github

Add a builder factory for L5-Swagger (#10)

## Overview

L5-Swagger 11.2.1 added a `builder_factory` scan option, which builds
the document through a
pre-configured swagger-php `Builder`. This adds a factory for it, so
plugging the introspector
into L5-Swagger is one line in `config/l5-swagger.php` instead of a
custom artisan command.

## Summary

- Setting `builder_factory` to `Integrations\L5Swagger\BuilderFactory`
documents the routes in the
`api` middleware group, in hybrid mode, so existing attributes are read
as they are
- L5-Swagger creates the factory from its class name, because Laravel's
config cache cannot hold an
object, so a project customises it by extending it: the routes, the
mode, the builder and the
  introspector each have their own method
- `darkaonline/l5-swagger` is suggested, and versions before 11.2.1
conflict, since they have no
  such option
- The README leads its L5-Swagger section with the config line, lists
which L5-Swagger settings
still reach the builder, and keeps the artisan command for older
versions
- `CONTEXT.md` defines an integration, next to an adapter

8 of 8 new or added lines in 1 file covered. (100.0%)

389 of 400 relevant lines covered (97.25%)

19.3 hits per line