Example Reference

This page is generated automatically from the swagger-php sources.

For improvements head over to GitHub and create a PR ;)

Api

A simple API example uing enums, traits and callbacks.

Server.php

<<< @/examples/specs/api/attributes/Server.php

<<< @/examples/specs/api/annotations/Server.php

Product.php

<<< @/examples/specs/api/attributes/Product.php

<<< @/examples/specs/api/annotations/Product.php

NameTrait.php

<<< @/examples/specs/api/attributes/NameTrait.php

<<< @/examples/specs/api/annotations/NameTrait.php

Colour.php

<<< @/examples/specs/api/attributes/Colour.php

<<< @/examples/specs/api/annotations/Colour.php

OpenApiSpec.php

<<< @/examples/specs/api/attributes/OpenApiSpec.php

<<< @/examples/specs/api/annotations/OpenApiSpec.php

ProductController.php

<<< @/examples/specs/api/attributes/ProductController.php

<<< @/examples/specs/api/annotations/ProductController.php

Petstore

Classic petstore sample app. Uses OAuth

Models/Category.php

<<< @/examples/specs/petstore/attributes/Models/Category.php

<<< @/examples/specs/petstore/annotations/Models/Category.php

Models/Order.php

<<< @/examples/specs/petstore/attributes/Models/Order.php

<<< @/examples/specs/petstore/annotations/Models/Order.php

Models/PetRequestBody.php

<<< @/examples/specs/petstore/attributes/Models/PetRequestBody.php

<<< @/examples/specs/petstore/annotations/Models/PetRequestBody.php

Models/Tag.php

<<< @/examples/specs/petstore/attributes/Models/Tag.php

<<< @/examples/specs/petstore/annotations/Models/Tag.php

Models/User.php

<<< @/examples/specs/petstore/attributes/Models/User.php

<<< @/examples/specs/petstore/annotations/Models/User.php

Models/ApiResponse.php

<<< @/examples/specs/petstore/attributes/Models/ApiResponse.php

<<< @/examples/specs/petstore/annotations/Models/ApiResponse.php

Models/UserArrayRequestBody.php

<<< @/examples/specs/petstore/attributes/Models/UserArrayRequestBody.php

<<< @/examples/specs/petstore/annotations/Models/UserArrayRequestBody.php

Models/Pet.php

<<< @/examples/specs/petstore/attributes/Models/Pet.php

<<< @/examples/specs/petstore/annotations/Models/Pet.php

Security.php

<<< @/examples/specs/petstore/attributes/Security.php

<<< @/examples/specs/petstore/annotations/Security.php

Controllers/UserController.php

<<< @/examples/specs/petstore/attributes/Controllers/UserController.php

<<< @/examples/specs/petstore/annotations/Controllers/UserController.php

Controllers/StoreController.php

<<< @/examples/specs/petstore/attributes/Controllers/StoreController.php

<<< @/examples/specs/petstore/annotations/Controllers/StoreController.php

Controllers/PetController.php

<<< @/examples/specs/petstore/attributes/Controllers/PetController.php

<<< @/examples/specs/petstore/annotations/Controllers/PetController.php

Petstore.php

<<< @/examples/specs/petstore/attributes/Petstore.php

<<< @/examples/specs/petstore/annotations/Petstore.php

Polymorphism

Demonstrates the use of Discriminator

Controller.php

<<< @/examples/specs/polymorphism/attributes/Controller.php

<<< @/examples/specs/polymorphism/annotations/Controller.php

Request.php

<<< @/examples/specs/polymorphism/attributes/Request.php

<<< @/examples/specs/polymorphism/annotations/Request.php

Employee.php

<<< @/examples/specs/polymorphism/attributes/Employee.php

<<< @/examples/specs/polymorphism/annotations/Employee.php

AbstractResponsible.php

<<< @/examples/specs/polymorphism/attributes/AbstractResponsible.php

<<< @/examples/specs/polymorphism/annotations/AbstractResponsible.php

Fl.php

<<< @/examples/specs/polymorphism/attributes/Fl.php

<<< @/examples/specs/polymorphism/annotations/Fl.php