Skip to content

Commit 087cf19

Browse files
committed
Update documentation
1 parent 2c4ba45 commit 087cf19

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,9 @@ Route::group(array('prefix' => 'api/v1', 'middleware' => []), function () {
6161
Option | Description
6262
--------- | -------
6363
`output` | The output path used for the generated documentation. Default: `public/docs`
64-
`routePrefix` | The route prefix to use for generation - `*` can be used as a wildcard
65-
`routes` | The route names to use for generation - Required if no routePrefix is provided
64+
`routePrefix` | The route prefix(es) to use for generation. `*` can be used as a wildcard. Multiple route prefixes can be specified by separating them with a comma (for instance `/v1,/v2`)
65+
`routeDomain` | The route domain(s) to use for generation. `*` can be used as a wildcard. Multiple route domains can be specified by separating them with a comma
66+
`routes` | The route names to use for generation - Required if no routePrefix or routeDomain is provided
6667
`middleware` | The middlewares to use for generation
6768
`noResponseCalls` | Disable API response calls
6869
`noPostmanCollection` | Disable Postman collection creation
@@ -92,7 +93,7 @@ This package uses these resources to generate the API documentation:
9293

9394
This package uses the HTTP controller doc blocks to create a table of contents and show descriptions for your API methods.
9495

95-
Using `@resource` in a doc block prior to each controller is useful as it creates a Group within the API documentation for all methods defined in that controller (rather than listing every method in a single list for all your controllers), but using `@resource` is not required. The short description after the `@resource` should be unique to allow anchor tags to navigate to this section. A longer description can be included below.
96+
Using `@resource` in a doc block prior to each controller is useful as it creates a Group within the API documentation for all methods defined in that controller (rather than listing every method in a single list for all your controllers), but using `@resource` is not required. The short description after the `@resource` should be unique to allow anchor tags to navigate to this section. A longer description can be included below. Custom formatting and `<aside>` tags are also supported. (see the [Documentarian docs](http://marcelpociot.de/documentarian/installation/markdown_syntax))
9697

9798
Above each method within the controller you wish to include in your API documentation you should have a doc block. This should include a unique short description as the first entry. An optional second entry can be added with further information. Both descriptions will appear in the API documentation in a different format as shown below.
9899

@@ -176,13 +177,14 @@ public function transformerCollectionTag()
176177
The @transformermodel tag is needed for PHP 5.* to get the model. For PHP 7 is it optional to specify the model that is used for the transformer.
177178

178179
#### @response
179-
If you expliciet want to specify the result of a function you can set it in the docblock
180+
If you explicitly want to specify the result of a function you can set it in the docblock as JSON, using the `@response` annotation:
180181

181182
```php
182183
/**
183184
* @response {
184-
* data: [],
185-
*}
185+
* "token": "eyJ0eXAi…",
186+
* "roles": ["admin"]
187+
* }
186188
*/
187189
public function responseTag()
188190
{

0 commit comments

Comments
 (0)