https://github.com/yiisoft/request-body-parser
Middleware for parsing various data formats
https://github.com/yiisoft/request-body-parser
content-type hacktoberfest json middleware psr-15 psr-7 xml yii3
Last synced: 3 months ago
JSON representation
Middleware for parsing various data formats
- Host: GitHub
- URL: https://github.com/yiisoft/request-body-parser
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2020-07-08T12:19:36.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-09T11:32:47.000Z (9 months ago)
- Last Synced: 2024-10-29T14:36:08.462Z (6 months ago)
- Topics: content-type, hacktoberfest, json, middleware, psr-15, psr-7, xml, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 87.9 KB
- Stars: 15
- Watchers: 17
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii Request Body Parser
[](https://packagist.org/packages/yiisoft/request-body-parser)
[](https://packagist.org/packages/yiisoft/request-body-parser)
[](https://github.com/yiisoft/request-body-parser/actions/workflows/build.yml)
[](https://codecov.io/gh/yiisoft/request-body-parser)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/request-body-parser/master)
[](https://github.com/yiisoft/request-body-parser/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/request-body-parser)
The package is [PSR-15](https://www.php-fig.org/psr/psr-15/) middleware that allows parsing [PSR-7](https://www.php-fig.org/psr/psr-7/)
server request body selecting the parser according to the server request mime type.
## Requirements
- PHP 7.4 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/request-body-parser
```
## General usage
1. Add `RequestBodyParser` to your middleware stack.
2. Obtain parsed body via `$request->getParsedBody();`.
By default, it parses `application/json` requests where JSON is in the body.
You can add your own parser by implementing `ParserInterface`, adding it into the container and registering it within
the middleware:
```php
$requestBodyParser = $requestBodyParser->withParser('application/myformat', MyFormatParser::class);
```
## Documentation
- [Internals](docs/internals.md)
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## License
The Yii Request Body Parser is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).
### Support the project
[](https://opencollective.com/yiisoft)
### Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)