Skip to content

Commit daff349

Browse files
committed
Update README.md
1 parent bb5248c commit daff349

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

README.md

+16-15
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
## Introduction
2525

26-
This plugin is designed to generate documentation for your REST API during the
26+
This plugin is designed to generate documentation for your REST API during the
2727
passing PHPUnit tests.
2828

2929
## Installation
@@ -35,11 +35,11 @@ composer require ronasit/laravel-swagger
3535
```
3636

3737
> ***Note***
38-
>
38+
>
3939
> For Laravel 5.5 or later the package will be auto-discovered.
4040
> For older versions add the `AutoDocServiceProvider` to the
4141
> providers array in `config/app.php` as follow:
42-
>
42+
>
4343
> ```php
4444
> 'providers' => [
4545
> ...
@@ -62,7 +62,9 @@ composer require ronasit/laravel-swagger
6262
6363
4. Add `\RonasIT\AutoDoc\Traits\AutoDocTestCaseTrait` trait to your `tests/TestCase.php` class
6464
5. Configure documentation saving using one of the next ways:
65-
- Add `SwaggerExtension` to the `<extensions>` block of your `phpunit.xml`.
65+
- Add `SwaggerExtension` to the `<extensions>` block of your `phpunit.xml`.
66+
**Please note that this way will be removed after updating**
67+
**PHPUnit up to 10 version (https://github.com/sebastianbergmann/phpunit/issues/4676)**
6668

6769
```xml
6870
<phpunit>
@@ -72,8 +74,8 @@ composer require ronasit/laravel-swagger
7274
</extensions>
7375
</phpunit>
7476
```
75-
- Call `php artisan swagger:push-documentation` console command after
76-
the `tests` stage.
77+
- Call `php artisan swagger:push-documentation` console command after
78+
the `tests` stage.
7779

7880
## Usage
7981

@@ -137,7 +139,7 @@ composer require ronasit/laravel-swagger
137139
> Plugin will take validation rules from the request class and generate fields description
138140
> of input parameter.
139141

140-
1. Implement request handling in the corresponding controller class:
142+
2. Implement request handling in the corresponding controller class:
141143

142144
```php
143145
<?php
@@ -157,12 +159,12 @@ composer require ronasit/laravel-swagger
157159
}
158160
```
159161

160-
> ***Note***
161-
>
162-
> Dependency injection of the request class is optional, but if it isn't present,
163-
> the 'Parameters' block in the API documentation will be empty.
162+
> ***Note***
163+
>
164+
> Dependency injection of request class is optional but if it not presents,
165+
> the "Parameters" block in the API documentation will be empty.
164166

165-
3. Create a test for the API endpoint:
167+
3. Create test for API endpoint:
166168

167169
```php
168170
public function testUpdate()
@@ -181,7 +183,7 @@ composer require ronasit/laravel-swagger
181183
5. Go to the route which is defined in the `auto-doc.route` config
182184
6. Profit!
183185

184-
![img.png](resources/assets/images/img.png)
186+
![img.png](resources/assets/images/img.png)
185187

186188
### Annotations
187189

@@ -225,5 +227,4 @@ can be found in the [Contributing guide](CONTRIBUTING.md).
225227

226228
## License
227229

228-
Laravel Swagger plugin is open-sourced software licensed under the [MIT license](LICENSE).
229-
230+
Laravel Swagger plugin is open-sourced software licensed under the [MIT license](LICENSE).

0 commit comments

Comments
 (0)