Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erasys/openapi-php
📚Swagger / Open API 3.0 builder and validation library for PHP that helps you write valid specs.
https://github.com/erasys/openapi-php
oai oas oasv3 openapi openapi-spec openapi3 swagger swagger3
Last synced: 8 days ago
JSON representation
📚Swagger / Open API 3.0 builder and validation library for PHP that helps you write valid specs.
- Host: GitHub
- URL: https://github.com/erasys/openapi-php
- Owner: erasys
- License: mit
- Created: 2018-04-16T18:32:26.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-06T11:15:36.000Z (8 months ago)
- Last Synced: 2024-04-26T22:02:27.374Z (7 months ago)
- Topics: oai, oas, oasv3, openapi, openapi-spec, openapi3, swagger, swagger3
- Language: PHP
- Homepage:
- Size: 95.7 KB
- Stars: 19
- Watchers: 12
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# openapi-php
[![Latest Version on Packagist][ico-version]][link-releases]
[![Software License][ico-license]](LICENSE)
[![Build Status][ico-travis]][link-travis]
[![Coverage Status][ico-coverage]][link-coverage]
[![Quality Score][ico-scrutinizer]][link-scrutinizer]
[![Total Downloads][ico-downloads]][link-downloads]
Open API 3.0 builder and validation library for PHP that helps you write valid specs.
[PSR-1]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md
[PSR-2]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md
[PSR-4]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md
This project is compliant with [PSR-1], [PSR-2] and [PSR-4].
If you notice compliance oversights, please send a patch via pull request.
## Features
- Fully documented object-oriented representation of the
[Open API 3.0+](https://github.com/OAI/OpenAPI-Specification/tree/master/versions) specification with helper methods
to write valid documents.
- Supports Illuminate (Laravel) [`Jsonable`](https://github.com/illuminate/contracts/blob/v5.4.0/Support/Jsonable.php)
and [`Arrayable`](https://github.com/illuminate/contracts/blob/v5.4.0/Support/Arrayable.php).
- Generates an specification in plain PHP arrays, plain objects, JSON or YAML.
- Validates Open API documents against the Open API 3.0.x JSON Schema.
## Install
Via Composer
``` bash
$ composer require erasys/openapi-php
```
Via Git
``` bash
$ git clone https://github.com/erasys/openapi-php.git
```
## Usage
Basic example:
```php
new OASv3\PathItem(
[
'get' => new OASv3\Operation(
[
'200' => new OASv3\Response('Successful response.'),
'default' => new OASv3\Response('Default error response.'),
]
),
]
),
]
);
$yaml = $doc->toYaml();
$json = $doc->toJson();
$arr = $doc->toArray();
$obj = $doc->toObject();
```
## Testing
``` bash
$ composer test
```
or
``` bash
$ vendor/bin/phpunit
$ vendor/bin/phpcs
```
## Contributing
Please see [CONTRIBUTING](https://github.com/erasys/openapi-php/blob/master/CONTRIBUTING.md) for details.
## License
The MIT License (MIT).
Please see [License File](https://github.com/erasys/openapi-php/blob/master/LICENSE) for more information.
[ico-version]: https://img.shields.io/packagist/v/erasys/openapi-php.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/erasys/openapi-php/master.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/erasys/openapi-php.svg?style=flat-square
[ico-coverage]: https://img.shields.io/scrutinizer/coverage/g/erasys/openapi-php.svg?style=flat-square
[ico-scrutinizer]: https://img.shields.io/scrutinizer/g/erasys/openapi-php.svg?style=flat-square
[link-releases]: https://packagist.org/packages/erasys/openapi-php
[link-travis]: https://travis-ci.org/erasys/openapi-php
[link-downloads]: https://packagist.org/packages/erasys/openapi-php
[link-coverage]: https://scrutinizer-ci.com/g/erasys/openapi-php/code-structure
[link-scrutinizer]: https://scrutinizer-ci.com/g/erasys/openapi-php