Skip to content

Commit ca5b9d0

Browse files
authored
Added routeMatcher config option to docs
1 parent 893666a commit ca5b9d0

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/config.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@ For each endpoint, an example request is shown in each of the languages specifie
5454

5555
## `faker_seed`
5656
When generating example requests, this package uses fzanninoto/faker to generate random values. If you would like the package to generate the same example values for parameters on each run, set this to any number (eg. 1234). (Note: alternatively, you can set example values for parameters when [documenting them.](documenting.html#specifying-request-parameters))
57+
58+
## `routeMatcher`
59+
The route matcher class provides the algorithm that determines what routes should be documented. The default matcher used is the included `\Mpociot\ApiDoc\Matching\RouteMatcher::class`, and you can provide your own custom implementation if you wish to programmatically change the algorithm. The provided matcher must be an instance of the `RouteMatcherInterface`.
5760

5861
## `fractal`
5962
This section only applies if you're using [Transformers]() for your API, and documenting responses with `@transformer` and `@transformerCollection`. Here, you configure how responses are transformed.

0 commit comments

Comments
 (0)