openapi-generator/samples/server/petstore/php-slim4

php-base - PHP Slim 4 Server library for OpenAPI Petstore

• OpenAPI Generator
• Slim 4 Documentation

This server has been generated with Slim PSR-7 implementation. PHP-DI package used as dependency container.

Requirements

• Web server with URL rewriting
• PHP 8.1 or newer

This package contains .htaccess for Apache configuration. If you use another server(Nginx, HHVM, IIS, lighttpd) check out Web Servers doc.

Installation via Composer

Navigate into your project's root directory and execute the bash command shown below. This command downloads the Slim Framework and its third-party dependencies into your project's vendor/ directory.

$ composer install

Add configs

PHP-DI package helps to decouple configuration from implementation. App loads configuration files in straight order($env can be prod or dev):

1. config/$env/default.inc.php (contains safe values, can be committed to vcs)
2. config/$env/config.inc.php (user config, excluded from vcs, can contain sensitive values, passwords etc.)
3. lib/App/RegisterDependencies.php

Start devserver

Run the following command in terminal to start localhost web server, assuming ./php-slim-server/public/ is public-accessible directory with index.php file:

$ php -S localhost:8888 -t php-slim-server/public

Warning

This web server was designed to aid application development. It may also be useful for testing purposes or for application demonstrations that are run in controlled environments. It is not intended to be a full-featured web server. It should not be used on a public network.

Tests

PHPUnit

This package uses PHPUnit 8 or 9(depends from your PHP version) for unit testing. Test folder contains templates which you can fill with real test assertions. How to write tests read at 2. Writing Tests for PHPUnit - PHPUnit 8.5 Manual.

Run

Command	Target
$ composer test	All tests
$ composer test-apis	Apis tests
$ composer test-models	Models tests

Config

Package contains fully functional config ./phpunit.xml.dist file. Create ./phpunit.xml in root folder to override it.

Quote from 3. The Command-Line Test Runner — PHPUnit 8.5 Manual:

If phpunit.xml or phpunit.xml.dist (in that order) exist in the current working directory and --configuration is not used, the configuration will be automatically read from that file.

PHP CodeSniffer

PHP CodeSniffer Documentation. This tool helps to follow coding style and avoid common PHP coding mistakes.

Run

$ composer phpcs

Config

Package contains fully functional config ./phpcs.xml.dist file. It checks source code against PSR-1 and PSR-2 coding standards. Create ./phpcs.xml in root folder to override it. More info at Using a Default Configuration File

PHPLint

PHPLint Documentation. Checks PHP syntax only.

Run

$ composer phplint

Show errors

Switch your app environment to development

• When using with some webserver => in public/.htaccess file:

## .htaccess
<IfModule mod_env.c>
    SetEnv APP_ENV 'development'
</IfModule>

• Or when using whatever else, set APP_ENV environment variable like this:

export APP_ENV=development

or simply

export APP_ENV=dev

Mock Server

Since this feature should be used for development only, change environment to development and send additional HTTP header X-OpenAPIServer-Mock: ping with any request to get mocked response. CURL example:

curl --request GET \
    --url 'http://localhost:8888/v2/pet/findByStatus?status=available' \
    --header 'accept: application/json' \
    --header 'X-OpenAPIServer-Mock: ping'
[{"id":-8738629417578509312,"category":{"id":-4162503862215270400,"name":"Lorem ipsum dol"},"name":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Lorem i","photoUrls":["Lor"],"tags":[{"id":-3506202845849391104,"name":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Lorem ipsum dolor sit amet, consectet"}],"status":"pending"}]

Used packages:

• Openapi Data Mocker - first implementation of OAS3 fake data generator.
• Openapi Data Mocker Server Middleware - PSR-15 HTTP server middleware.
• Openapi Data Mocker Interfaces - package with mocking interfaces.

Logging

Build contains pre-configured monolog/monolog package. Make sure that logs folder is writable. Add required log handlers/processors/formatters in lib/App/RegisterDependencies.php.

API Endpoints

All URIs are relative to http://petstore.swagger.io/v2

Important! Do not modify abstract API controllers directly! Instead extend them by implementation classes like:

// src/Api/PetApi.php

namespace OpenAPIServer\Api;

use OpenAPIServer\Api\AbstractPetApi;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\ResponseInterface;

class PetApi extends AbstractPetApi
{
    public function addPet(
        ServerRequestInterface $request,
        ResponseInterface $response
    ): ResponseInterface {
        // your implementation of addPet method here
    }
}

When you need to inject dependencies into API controller check PHP-DI - Controllers as services guide.

Place all your implementation classes in ./src folder accordingly. For instance, when abstract class located at ./lib/Api/AbstractPetApi.php you need to create implementation class at ./src/Api/PetApi.php.

Class	Method	HTTP request	Description
AbstractPetApi	addPet	POST /pet	Add a new pet to the store
AbstractPetApi	findPetsByStatus	GET /pet/findByStatus	Finds Pets by status
AbstractPetApi	findPetsByTags	GET /pet/findByTags	Finds Pets by tags
AbstractPetApi	updatePet	PUT /pet	Update an existing pet
AbstractPetApi	deletePet	DELETE /pet/{petId}	Deletes a pet
AbstractPetApi	getPetById	GET /pet/{petId}	Find pet by ID
AbstractPetApi	updatePetWithForm	POST /pet/{petId}	Updates a pet in the store with form data
AbstractPetApi	uploadFile	POST /pet/{petId}/uploadImage	uploads an image
AbstractStoreApi	getInventory	GET /store/inventory	Returns pet inventories by status
AbstractStoreApi	placeOrder	POST /store/order	Place an order for a pet
AbstractStoreApi	deleteOrder	DELETE /store/order/{orderId}	Delete purchase order by ID
AbstractStoreApi	getOrderById	GET /store/order/{orderId}	Find purchase order by ID
AbstractUserApi	createUser	POST /user	Create user
AbstractUserApi	createUsersWithArrayInput	POST /user/createWithArray	Creates list of users with given input array
AbstractUserApi	createUsersWithListInput	POST /user/createWithList	Creates list of users with given input array
AbstractUserApi	loginUser	GET /user/login	Logs user into the system
AbstractUserApi	logoutUser	GET /user/logout	Logs out current logged in user session
AbstractUserApi	deleteUser	DELETE /user/{username}	Delete user
AbstractUserApi	getUserByName	GET /user/{username}	Get user by user name
AbstractUserApi	updateUser	PUT /user/{username}	Updated user

Models

• OpenAPIServer\Model\ApiResponse
• OpenAPIServer\Model\Category
• OpenAPIServer\Model\Order
• OpenAPIServer\Model\Pet
• OpenAPIServer\Model\Tag
• OpenAPIServer\Model\User

Authentication

Security schema petstore_auth

Important! To make OAuth authentication work you need to extend \OpenAPIServer\Auth\AbstractAuthenticator class by \OpenAPIServer\Auth\OAuthAuthenticator class.

Scope list:

• write:pets - modify pets in your account
• read:pets - read your pets

Security schema api_key

Important! To make ApiKey authentication work you need to extend \OpenAPIServer\Auth\AbstractAuthenticator class by \OpenAPIServer\Auth\ApiKeyAuthenticator class.

Advanced middleware configuration

Ref to used Slim Token Middleware dyorg/slim-token-authentication