https://github.com/cnizzardini/cakephp-swagger-bake-demo
Demo application for SwaggerBake
https://github.com/cnizzardini/cakephp-swagger-bake-demo
Last synced: 6 days ago
JSON representation
Demo application for SwaggerBake
- Host: GitHub
- URL: https://github.com/cnizzardini/cakephp-swagger-bake-demo
- Owner: cnizzardini
- License: other
- Created: 2020-04-18T00:59:04.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-08T15:14:45.000Z (over 1 year ago)
- Last Synced: 2025-04-23T22:33:34.015Z (3 months ago)
- Language: PHP
- Homepage: https://cakephpswaggerbake.cnizz.com
- Size: 2.06 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Swagger Bake Demo Application
[Demo Site](http://cakephpswaggerbake.cnizz.com/) |
[Project Home](https://github.com/cnizzardini/cakephp-swagger-bake)
Submit problems or requests for additional examples as github issues.
## Installation
Clone repository:
```console
git clone [email protected]:cnizzardini/cakephp-swagger-bake-demo.git
```
Install via composer:
```console
composer install
```
Configure the application for database access using `config/.env` or `config/app_local.php`, then run
migrations to build/seed your database. The default in `config/app.php` will work with sqlite3.
```console
bin/cake migrations migrate -p Sakila
bin/cake migrations seed -p Sakila
```
Configure your web server or run the cake web server:
```console
bin/cake server
```
That's it, you're done!
## Examples
Here is a list of some examples. It's best to search `src/` for an exhaustive list of examples.
| Feature | Example |
|------------------------------|-------------------------------------------------------------------------------------------|
| SwaggerBake Events | [App\Event\SwaggerBakeListener](src/Event/SwaggerBakeListener.php) |
| OpenApiDto | [App\Controller\ExamplesControllers](src/Controller/ExamplesController.php) |
| OpenApiForm | [App\Controller\ExamplesController::formExample](src/Controller/ExamplesControllers.php) |
| OpenApiHeader | [App\Controller\ExamplesController::headerExample](src/Controller/ExamplesController.php) |
| OpenApiOperation | [App\Controller\ActorsController::index](src/Controller/ActorsController.php) |
| OpenApiPaginator | Most controller `index()` actions have this defined |
| OpenApiPath | |
| OpenApiPathParam | |
| OpenApiQueryParam | [App\Controller\ExamplesController::headerExample](src/Controller/ExamplesController.php) |
| OpenApiRequestBody | |
| OpenApiResponse | [App\Controller\CountriesController](src/Controller/CountriesController.php) |
| OpenApiResponse associations | [App\Controller\ActorsController::films](src/Controller/ActorsController.php) |
| OpenApiResponse schema | [App\Controller\ExamplesControllers](src/Controller/ExamplesController.php) |
| OpenApiSchema | [App\Model\Entity\Rental](src/Model/Entity.php) |
| OpenApiSchemaProperty | |
| OpenApiSearch | [FilmsController::index](src/Controller/FilmsController) |
| OpenApiSecurity | |