Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
59 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,54 +1,80 @@ | ||
# Apitte OpenApi | ||
![Apitte OpenApi](https://heatbadger.now.sh/github/readme/apitte/openapi/) | ||
|
||
Convert [Apitte](https://github.com/apitte/core) schema to [OpenApi Schema](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md) | ||
and add [Swagger UI](https://petstore.swagger.io) as [Tracy](https://github.com/nette/tracy) panel | ||
<p align=center> | ||
<a href="https://github.com/apitte/openapi/actions"> | ||
<img src="https://badgen.net/github/checks/apitte/openapi/master?cache=300"> | ||
</a> | ||
<a href="https://coveralls.io/r/apitte/openapi"> | ||
<img src="https://badgen.net/coveralls/c/github/apitte/openapi?cache=300"> | ||
</a> | ||
<a href="https://packagist.org/packages/apitte/openapi"> | ||
<img src="https://badgen.net/packagist/dm/apitte/openapi"> | ||
</a> | ||
<a href="https://packagist.org/packages/apitte/openapi"> | ||
<img src="https://badgen.net/packagist/v/apitte/openapi"> | ||
</a> | ||
</p> | ||
<p align=center> | ||
<a href="https://packagist.org/packages/apitte/openapi"> | ||
<img src="https://badgen.net/packagist/php/apitte/openapi"> | ||
</a> | ||
<a href="https://github.com/apitte/openapi"> | ||
<img src="https://badgen.net/github/license/apitte/openapi"> | ||
</a> | ||
<a href="http://bit.ly/apittegitter"> | ||
<img src="https://badgen.net/badge/chat/apitte/cyan"> | ||
</a> | ||
<a href="https://bit.ly/cttfo"> | ||
<img src="https://badgen.net/badge/support/forum/yellow"> | ||
</a> | ||
<a href="https://contributte.org/partners.html"> | ||
<img src="https://badgen.net/badge/become/a%20patron/F96854"> | ||
</a> | ||
<p> | ||
|
||
[![Build Status](https://img.shields.io/travis/apitte/openapi.svg?style=flat-square)](https://travis-ci.org/apitte/openapi) | ||
[![Code coverage](https://img.shields.io/coveralls/apitte/openapi.svg?style=flat-square)](https://coveralls.io/r/apitte/openapi) | ||
[![Licence](https://img.shields.io/packagist/l/apitte/openapi.svg?style=flat-square)](https://packagist.org/packages/apitte/openapi) | ||
[![Downloads this Month](https://img.shields.io/packagist/dm/apitte/openapi.svg?style=flat-square)](https://packagist.org/packages/apitte/openapi) | ||
[![Downloads total](https://img.shields.io/packagist/dt/apitte/openapi.svg?style=flat-square)](https://packagist.org/packages/apitte/openapi) | ||
[![Latest stable](https://img.shields.io/packagist/v/apitte/openapi.svg?style=flat-square)](https://packagist.org/packages/apitte/openapi) | ||
[![PHPStan](https://img.shields.io/badge/PHPStan-enabled-brightgreen.svg?style=flat-square)](https://github.com/phpstan/phpstan) | ||
<p align=center> | ||
Website 馃殌 <a href="https://contributte.org">contributte.org</a> | Contact 馃懆馃徎馃捇 <a href="https://f3l1x.io">f3l1x.io</a> | Twitter 馃惁 <a href="https://twitter.com/contributte">@contributte</a> | ||
</p> | ||
|
||
## Discussion / Help | ||
## Usage | ||
|
||
[![Join the chat](https://img.shields.io/gitter/room/apitte/apitte.svg?style=flat-square)](https://gitter.im/apitte/apitte) | ||
To install the latest version of `apitte/openapi` use [Composer](https://getcomposer.com). | ||
|
||
``` | ||
composer require apitte/openapi | ||
``` | ||
|
||
## Documentation | ||
|
||
- [Setup](.docs/README.md#setup) | ||
- [Usage](.docs/README.md#usage) | ||
For details on how to use this package, check out our [documentation](.docs). | ||
|
||
## Version | ||
|
||
| State | Version | Branch | Nette | PHP | | ||
|-------------|---------|----------|-------|---------| | ||
| dev | `^0.7` | `master` | 3.0+ | `>=7.2` | | ||
| dev | `^0.8` | `master` | 3.0+ | `>=7.2` | | ||
| stable | `^0.7` | `master` | 3.0+ | `>=7.2` | | ||
| stable | `^0.6` | `master` | 3.0+ | `^7.2` | | ||
| stable | `^0.5` | `master` | 2.4 | `>=7.1` | | ||
| stable | `^0.3` | `master` | 2.4 | `>=5.6` | | ||
|
||
![](https://github.com/apitte/openapi/blob/master/.docs/assets/panel.png "Tracy Panel") | ||
|
||
## Maintainers | ||
|
||
<table> | ||
<tbody> | ||
<tr> | ||
<td align="center"> | ||
<a href="https://github.com/f3l1x"> | ||
<img width="150" height="150" src="https://avatars2.githubusercontent.com/u/538058?v=3&s=150"> | ||
</a> | ||
</br> | ||
<a href="https://github.com/f3l1x">Milan Felix 艩ulc</a> | ||
</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
|
||
## Development | ||
|
||
See [how to contribute](https://contributte.org/contributing.html) to this package. | ||
|
||
This package is currently maintaining by these authors. | ||
|
||
<a href="https://github.com/f3l1x"> | ||
<img width="80" height="80" src="https://avatars2.githubusercontent.com/u/538058?v=3&s=80"> | ||
</a> | ||
|
||
## Sponsoring | ||
|
||
<a href="https://github.com/tlapnet"><img width="200" src="https://avatars.githubusercontent.com/tlapnet"></a> | ||
<a href="https://github.com/tlapnet"> | ||
<img width="80" height="80" src="https://avatars1.githubusercontent.com/u/22914186?s=80&v=4"> | ||
</a> | ||
|
||
The development is sponsored by [Tlapnet](https://www.tlapnet.cz) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters