Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DerManoMann committed Dec 1, 2023
1 parent 71b4229 commit 45d4f54
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# swagger-php

Generate interactive [OpenAPI](https://www.openapis.org) documentation for your RESTful API using [doctrine annotations](https://www.doctrine-project.org/projects/doctrine-annotations/en/latest/index.html).
Generate interactive [OpenAPI](https://www.openapis.org) documentation for your RESTful API using [doctrine annotations](https://www.doctrine-project.org/projects/doctrine-annotations/en/latest/index.html) (optional as of version 4.8) or PHP attributes.

For a full list of supported annotations, please have look at the [`OpenApi\Annotations` namespace](src/Annotations) or the [documentation website](https://zircote.github.io/swagger-php/guide/annotations.html).

Expand Down Expand Up @@ -41,6 +41,16 @@ For cli usage from anywhere install swagger-php globally and make sure to place
composer global require zircote/swagger-php
```

### doctrine/annotations
As of version `4.8` the [doctrine annotations](https://www.doctrine-project.org/projects/doctrine-annotations/en/latest/index.html) library **is optional** and **no longer installed by default**.

If your code uses PHPDoc annotations you will need to install this as well:

```shell
composer require doctrine/annotations
```


## Usage

Add annotations to your php files.
Expand Down

0 comments on commit 45d4f54

Please sign in to comment.