Skip to content

fix: refactor readme.md #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 9, 2025
Merged

fix: refactor readme.md #165

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1f194a
fix: refactor readme.md
yogyrton Apr 9, 2025
fcc1c21
Apply suggestions from code review
DenTray Apr 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,13 @@ passing PHPUnit tests.
> ],
> ```

2. Run `php artisan vendor:publish --provider=RonasIT\\AutoDoc\\AutoDocServiceProvider`
1. Add `\RonasIT\AutoDoc\Http\Middleware\AutoDocMiddleware::class` middleware to the global HTTP middleware list `bootstrap\app.php`:
2. Run

```
php artisan vendor:publish --provider=RonasIT\\AutoDoc\\AutoDocServiceProvider
```

3. Add `\RonasIT\AutoDoc\Http\Middleware\AutoDocMiddleware::class` middleware to the global HTTP middleware list `bootstrap\app.php`:

```php
return Application::configure(basePath: dirname(__DIR__))
Expand All @@ -57,7 +62,8 @@ passing PHPUnit tests.
```

4. Add `\RonasIT\AutoDoc\Traits\AutoDocTestCaseTrait` trait to `tests/TestCase.php`
1. Configure documentation saving using one of the next ways:

5. Configure documentation saving using one of the next ways:
- Add `SwaggerExtension` to the `<extensions>` block of your `phpunit.xml`.
**Please note that this way will be removed after updating**
**PHPUnit up to 10 version (https://github.com/sebastianbergmann/phpunit/issues/4676)**
Expand Down Expand Up @@ -232,4 +238,3 @@ can be found in the [Contributing guide](CONTRIBUTING.md).
## License

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