|
|
@@ -61,8 +61,9 @@ Route::group(array('prefix' => 'api/v1', 'middleware' => []), function () {
|
|
|
Option | Description
|
|
|
--------- | -------
|
|
|
`output` | The output path used for the generated documentation. Default: `public/docs`
|
|
|
-`routePrefix` | The route prefix to use for generation - `*` can be used as a wildcard
|
|
|
-`routes` | The route names to use for generation - Required if no routePrefix is provided
|
|
|
+`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`)
|
|
|
+`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
|
|
|
+`routes` | The route names to use for generation - Required if no routePrefix or routeDomain is provided
|
|
|
`middleware` | The middlewares to use for generation
|
|
|
`noResponseCalls` | Disable API response calls
|
|
|
`noPostmanCollection` | Disable Postman collection creation
|
|
|
@@ -92,7 +93,7 @@ This package uses these resources to generate the API documentation:
|
|
|
|
|
|
This package uses the HTTP controller doc blocks to create a table of contents and show descriptions for your API methods.
|
|
|
|
|
|
-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.
|
|
|
+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))
|
|
|
|
|
|
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.
|
|
|
|
|
|
@@ -176,13 +177,14 @@ public function transformerCollectionTag()
|
|
|
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.
|
|
|
|
|
|
#### @response
|
|
|
-If you expliciet want to specify the result of a function you can set it in the docblock
|
|
|
+If you explicitly want to specify the result of a function you can set it in the docblock as JSON, using the `@response` annotation:
|
|
|
|
|
|
```php
|
|
|
/**
|
|
|
* @response {
|
|
|
- * data: [],
|
|
|
- *}
|
|
|
+ * "token": "eyJ0eXAi…",
|
|
|
+ * "roles": ["admin"]
|
|
|
+ * }
|
|
|
*/
|
|
|
public function responseTag()
|
|
|
{
|
Shalvah A