https://github.com/justcoded/yii2-swaggerviewer
Yii2 Swagger docs viewer module
https://github.com/justcoded/yii2-swaggerviewer
Last synced: 6 months ago
JSON representation
Yii2 Swagger docs viewer module
- Host: GitHub
- URL: https://github.com/justcoded/yii2-swaggerviewer
- Owner: justcoded
- Archived: true
- Created: 2018-05-08T09:18:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-11T13:40:55.000Z (over 7 years ago)
- Last Synced: 2025-03-24T13:21:22.569Z (10 months ago)
- Language: PHP
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Yii2 Swagger Viewer Module
=========================
Viewer of a separate yaml/json swagger docs. Include swagger multi-doc merger, so you can format your docs in multiple files for faster edits.
This package is based on our SwaggerTools pack.
Example of docs to view can be found here:
[SwaggerTools docs example](https://github.com/justcoded/swagger-tools/tree/master/examples/v2.0)
As extra feature, you can provide additional properties to generate enums, which are usually
used by mock servers to generate test responses.
We recommend [Prism](https://stoplight.io/platform/prism/) mock server. If you specify correct
validation rules (like minimum, maximum, minItems, maxItems, etc.) it will generate nice mocks
with data generated by faker php lib.
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist justcoded/yii2-swaggerviewer "*"
```
or add
```
"justcoded/yii2-swaggerviewer": "*"
```
to the require section of your `composer.json` file.
Configuration
------------
Add module to your web config file:
```php
'modules' => [
'swagger' => [
'class' => \justcoded\yii2\swaggerviewer\Module::class,
'docsPath' => '@app/docs/swagger/swagger.yaml',
// use merger tool. if you have single file - can turn it off for faster load.
'multiDoc' => true,
// enable faker tool. additional link will be provided to download fakered copy.
'fakerCopy' => true,
'fakerNum' => 10, // number of items to generate
],
],
```