You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting-started/configuration.md
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -64,13 +64,13 @@ You can specify a custom logo to be used on the generated documentation. Set the
64
64
If you want to use this, please note that the image size must be 230 x 52.
65
65
66
66
## default_group
67
-
When [documenting your api](/docs/laravel-api-doc-generator/getting-started/documenting-your-api), you use `@group` annotations to group API endpoints. Endpoints which do not have a group annotation will be grouped under the `default_group`. Defaults to **"general"**.
67
+
When [documenting your api](/docs/laravel-apidoc-generator/getting-started/documenting-your-api), you use `@group` annotations to group API endpoints. Endpoints which do not have a group annotation will be grouped under the `default_group`. Defaults to **"general"**.
68
68
69
69
## example_languages
70
-
For each endpoint, an example request is shown in each of the languages specified in this array. Currently only `bash`, `javascript`, `php` and `python` are supported. You can add your own language, but you must also define the corresponding view (see [Specifying languages for examples](/docs/laravel-api-doc-generator/getting-started/generating-documentation)). Default: `["bash", "javascript"]`
70
+
For each endpoint, an example request is shown in each of the languages specified in this array. Currently only `bash`, `javascript`, `php` and `python` are supported. You can add your own language, but you must also define the corresponding view (see [Specifying languages for examples](/docs/laravel-apidoc-generator/getting-started/generating-documentation)). Default: `["bash", "javascript"]`
71
71
72
72
## faker_seed
73
-
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.](/docs/laravel-api-doc-generator/getting-started/documenting-your-api))
73
+
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.](/docs/laravel-apidoc-generator/getting-started/documenting-your-api))
74
74
75
75
## routeMatcher
76
76
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`.
@@ -246,7 +246,7 @@ These values support wildcards and paths, so you can have `'exclude' => ['users/
246
246
After defining the routes in `match` (and `include` or `exclude`), `apply` is where you specify the settings to be applied to those routes when generating documentation. There are a bunch of settings you can tweak here:
247
247
248
248
### headers
249
-
Like we've demonstrated above, any headers you specify here will be added to the headers shown in the example requests in your documentation. They will also be included in ["response calls"](/docs/laravel-api-doc-generator/getting-started/documenting-your-api). Headers are specified as key => value strings.
249
+
Like we've demonstrated above, any headers you specify here will be added to the headers shown in the example requests in your documentation. They will also be included in ["response calls"](/docs/laravel-apidoc-generator/getting-started/documenting-your-api). Headers are specified as key => value strings.
250
250
251
251
### response_calls
252
-
These are the settings that will be applied when making ["response calls"](/docs/laravel-api-doc-generator/getting-started/documenting-your-api). See the linked section for details.
252
+
These are the settings that will be applied when making ["response calls"](/docs/laravel-apidoc-generator/getting-started/documenting-your-api). See the linked section for details.
Copy file name to clipboardExpand all lines: docs/getting-started/migrating.md
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -15,9 +15,9 @@ Note: This isn't meant to be an exhaustive guide to the changes in v4. Please se
15
15
16
16
- Remove the `output` key. Source files now go to `resources/docs/source` and generated docs go to either `public/docs/` or `resources/views/apidoc`.
17
17
18
-
- Make sure the `type` value is set appropriately. See [the docs](/docs/laravel-api-doc-generator/getting-started/configuration).
18
+
- Make sure the `type` value is set appropriately. See [the docs](/docs/laravel-apidoc-generator/getting-started/configuration).
19
19
20
-
- Remove the `bindings` section. It has been superseded by the `@urlParam` annotation, which works similarly to the existing `@queryParam` annotation. See [the docs](/docs/laravel-api-doc-generator/getting-started/documenting-your-api)
20
+
- Remove the `bindings` section. It has been superseded by the `@urlParam` annotation, which works similarly to the existing `@queryParam` annotation. See [the docs](/docs/laravel-apidoc-generator/getting-started/documenting-your-api)
21
21
22
22
- Remove the `response_calls.bindings` section. Use the `Example: ` feature of `@urlParam` to specify the value you want to be used in response calls.
23
23
@@ -32,9 +32,9 @@ The major change here is the introduction of the `urlParameters` section and the
32
32
- The location of the source files for the generated docs has changed. Move any prepend/append files you've created from `public/docs/source` to the new location (`resources/docs/source`)
33
33
34
34
## API
35
-
- Verify that any custom strategies you've written match the new signatures. See [the docs](/docs/laravel-api-doc-generator/extending/plugins). Also note the order of execution and the new stages present.
35
+
- Verify that any custom strategies you've written match the new signatures. See [the docs](/docs/laravel-apidoc-generator/extending/plugins). Also note the order of execution and the new stages present.
36
36
37
37
## Other new features (highlights)
38
-
-[Non-static docs/docs with authentication](/docs/laravel-api-doc-generator/getting-started/configuration)
39
-
-[`@apiResource` for Eloquent API resources](/docs/laravel-api-doc-generator/getting-started/documenting-your-api)
38
+
-[Non-static docs/docs with authentication](/docs/laravel-apidoc-generator/getting-started/configuration)
39
+
-[`@apiResource` for Eloquent API resources](/docs/laravel-apidoc-generator/getting-started/documenting-your-api)
40
40
- You can now mix and match response strategies and status codes as you like.
0 commit comments