An open API service indexing awesome lists of open source software.

https://github.com/phpinnacle/intellij-redoc

IntelliJ OpenAPI 3.0 documentation renderer
https://github.com/phpinnacle/intellij-redoc

Last synced: 4 months ago
JSON representation

IntelliJ OpenAPI 3.0 documentation renderer

Awesome Lists containing this project

README

          

# PHPinnacle Redoc IntelliJ Plugin

[![Version][ico-version]]()
[![Software License][ico-license]](LICENSE.md)

Display OpenAPI and Swagger specifications documentation fast and effectively​ with [Redoc][link-redoc].

Features:
* OpenAPI 3.0 and Swagger 2.0 specifications
* Specifications in YAML or JSON

## Install

Via IntelliJ platform marketplace

## Usage

Open a Swagger or OpenAPI specification file, that's it.

## Testing

TODO

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.

## Credits

- [PHPinnacle][link-author]
- [All Contributors][link-contributors]

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

[ico-version]: https://img.shields.io/jetbrains/plugin/v/12822-redoc?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square

[link-redoc]: https://github.com/Redocly/redoc
[link-author]: https://github.com/phpinnacle
[link-contributors]: https://github.com/phpinnacle/intellij-redoc/graphs/contributors