Skip to content

Commit

Permalink
Add example of using -b to basic CLI example (#1659)
Browse files Browse the repository at this point in the history
  • Loading branch information
DerManoMann authored Sep 26, 2024
1 parent e10883c commit 7642943
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/guide/generating-openapi-documents.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,17 @@ the tool will use the file extension to determine the format.
The `--format` option can be used to force a specific format.
:::

::: tip Bootstrap
The bootstrap option `-b` is useful when trying to use `swagger-php` without proper autoloading.

For example, you might want to evaluate the library using a single file with just a few annotations. In this case telling swagger-php to bootstrap (pre-load) the file prior to processing it will ensure PHP's `reflection` code will be able to inspect your code.

```shell
> ./vendor/bin/openapi -b my_file.php my_file.php
```
:::


For a list of all available options use the `-h` option

```shell
Expand Down

0 comments on commit 7642943

Please sign in to comment.