mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-06-12 03:40:59 +00:00
8e78b14e28
* [Slim4] Copy Slim3 generator as starting point * [Slim4] Add psr7Implementation generator option Slim supports PSR-7 interfaces for its Request and Response objects. Slim provides its own PSR-7 implementation so that it works out of the box. However, you are free to replace Slim’s default PSR-7 objects with a third-party implementation. [Ref] https://www.slimframework.com/docs/v4/concepts/value-objects.html * [Slim4] Handle psr7Implementation generator option It somehow ended up with composerPackages and composerDevPackages codegen variables and two additional functions. Hope, it's not too much. * [Slim4] Extend from Slim3 generator * [Slim4] Bump PHP Slim Framework version to 4.0.0 * [Slim4] Bump required PHP version to 7.1 [Upgrade Guide](https://www.slimframework.com/docs/v4/start/upgrade.html) * [Slim4] Remove app settings Slim’s App settings used to be a part of the container and they have now been decoupled from it. [Upgrade Guide](https://www.slimframework.com/docs/v4/start/upgrade.html) * [Slim4] Set container argument optional Slim uses an optional dependency container to prepare, manage, and inject application dependencies. Slim supports containers that implement PSR-11 like [PHP-DI](http://php-di.org/doc/frameworks/slim.html). [Upgrade Guide](https://www.slimframework.com/docs/v4/start/upgrade.html) * [Slim4] Change response body write You can't write to response instance directly anymore, need to retrieve body object first. [Doc](https://www.slimframework.com/docs/v4/objects/response.html#the-response-body) * [Slim4] Change Slim\App constructor [Upgrade Guide](https://www.slimframework.com/docs/v4/start/upgrade.html) * [Slim4] Refactor token authentication options User can provide array or Container as constructor argument from now. Small refactoring required to retrieve authentication options from that argument. * [Slim4] Add PSR-7 implementation codegen flags This approach seems more flexible to me. User can customize templates in favor of chosen PSR7 implementation. It's easier to change Composer packages and their versions. * [Slim4] Add JsonBodyParserMiddleware Slim4 doesn't parse JSON body, need to add suggested middleware. Ref: https://www.slimframework.com/docs/v4/objects/request.html#the-request-body * [Slim4] Remove request's deprecated methods usage Since Slim 4.0.0 ServerRequest implementation doesn't have getQueryParam and getParsedBodyParam methods anymore. * [Slim4] Use getUploadedFiles for multipart request isMultipart codegen property is always false so far. Hope that bug will be fixed soon. * [Slim4] Add samples
762 lines
28 KiB
PHP
762 lines
28 KiB
PHP
<?php
|
|
/**
|
|
* SlimRouter
|
|
*
|
|
* PHP version 7.1
|
|
*
|
|
* @package OpenAPIServer
|
|
* @author OpenAPI Generator team
|
|
* @link https://github.com/openapitools/openapi-generator
|
|
*/
|
|
|
|
/**
|
|
* OpenAPI Petstore
|
|
*
|
|
* This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
|
|
* The version of the OpenAPI document: 1.0.0
|
|
* Generated by: https://github.com/openapitools/openapi-generator.git
|
|
*/
|
|
|
|
/**
|
|
* NOTE: This class is auto generated by the openapi generator program.
|
|
* https://github.com/openapitools/openapi-generator
|
|
* Do not edit the class manually.
|
|
*/
|
|
namespace OpenAPIServer;
|
|
|
|
use Slim\Factory\AppFactory;
|
|
use Slim\Interfaces\RouteInterface;
|
|
use Psr\Container\ContainerInterface;
|
|
use InvalidArgumentException;
|
|
use Dyorg\TokenAuthentication;
|
|
use Dyorg\TokenAuthentication\TokenSearch;
|
|
use Psr\Http\Message\ServerRequestInterface;
|
|
use OpenAPIServer\Middleware\JsonBodyParserMiddleware;
|
|
use Exception;
|
|
|
|
/**
|
|
* SlimRouter Class Doc Comment
|
|
*
|
|
* @package OpenAPIServer
|
|
* @author OpenAPI Generator team
|
|
* @link https://github.com/openapitools/openapi-generator
|
|
*/
|
|
class SlimRouter
|
|
{
|
|
|
|
/** @var App instance */
|
|
private $slimApp;
|
|
|
|
/** @var array[] list of all api operations */
|
|
private $operations = [
|
|
[
|
|
'httpMethod' => 'PATCH',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/another-fake/dummy',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractAnotherFakeApi',
|
|
'userClassname' => 'AnotherFakeApi',
|
|
'operationId' => 'call123TestSpecialTags',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'POST',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/fake/create_xml_item',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractFakeApi',
|
|
'userClassname' => 'FakeApi',
|
|
'operationId' => 'createXmlItem',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'POST',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/fake/outer/boolean',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractFakeApi',
|
|
'userClassname' => 'FakeApi',
|
|
'operationId' => 'fakeOuterBooleanSerialize',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'POST',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/fake/outer/composite',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractFakeApi',
|
|
'userClassname' => 'FakeApi',
|
|
'operationId' => 'fakeOuterCompositeSerialize',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'POST',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/fake/outer/number',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractFakeApi',
|
|
'userClassname' => 'FakeApi',
|
|
'operationId' => 'fakeOuterNumberSerialize',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'POST',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/fake/outer/string',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractFakeApi',
|
|
'userClassname' => 'FakeApi',
|
|
'operationId' => 'fakeOuterStringSerialize',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'PUT',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/fake/body-with-file-schema',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractFakeApi',
|
|
'userClassname' => 'FakeApi',
|
|
'operationId' => 'testBodyWithFileSchema',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'PUT',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/fake/body-with-query-params',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractFakeApi',
|
|
'userClassname' => 'FakeApi',
|
|
'operationId' => 'testBodyWithQueryParams',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'PATCH',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/fake',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractFakeApi',
|
|
'userClassname' => 'FakeApi',
|
|
'operationId' => 'testClientModel',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'POST',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/fake',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractFakeApi',
|
|
'userClassname' => 'FakeApi',
|
|
'operationId' => 'testEndpointParameters',
|
|
'authMethods' => [
|
|
// http security schema named 'http_basic_test'
|
|
[
|
|
'type' => 'http',
|
|
'isBasic' => true,
|
|
'isBearer' => false,
|
|
'isApiKey' => false,
|
|
'isOAuth' => false,
|
|
],
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'GET',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/fake',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractFakeApi',
|
|
'userClassname' => 'FakeApi',
|
|
'operationId' => 'testEnumParameters',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'DELETE',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/fake',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractFakeApi',
|
|
'userClassname' => 'FakeApi',
|
|
'operationId' => 'testGroupParameters',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'POST',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/fake/inline-additionalProperties',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractFakeApi',
|
|
'userClassname' => 'FakeApi',
|
|
'operationId' => 'testInlineAdditionalProperties',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'GET',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/fake/jsonFormData',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractFakeApi',
|
|
'userClassname' => 'FakeApi',
|
|
'operationId' => 'testJsonFormData',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'PUT',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/fake/test-query-paramters',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractFakeApi',
|
|
'userClassname' => 'FakeApi',
|
|
'operationId' => 'testQueryParameterCollectionFormat',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'PATCH',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/fake_classname_test',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractFakeClassnameTags123Api',
|
|
'userClassname' => 'FakeClassnameTags123Api',
|
|
'operationId' => 'testClassname',
|
|
'authMethods' => [
|
|
// apiKey security schema named 'api_key_query'
|
|
[
|
|
'type' => 'apiKey',
|
|
'isBasic' => false,
|
|
'isBearer' => false,
|
|
'isApiKey' => true,
|
|
'isOAuth' => false,
|
|
'keyParamName' => 'api_key_query',
|
|
'isKeyInHeader' => false,
|
|
'isKeyInQuery' => true,
|
|
'isKeyInCookie' => false,
|
|
],
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'POST',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/pet',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractPetApi',
|
|
'userClassname' => 'PetApi',
|
|
'operationId' => 'addPet',
|
|
'authMethods' => [
|
|
// oauth2 security schema named 'petstore_auth'
|
|
[
|
|
'type' => 'oauth2',
|
|
'isBasic' => false,
|
|
'isBearer' => false,
|
|
'isApiKey' => false,
|
|
'isOAuth' => true,
|
|
'scopes' => [
|
|
'write:pets', // modify pets in your account
|
|
'read:pets', // read your pets
|
|
],
|
|
],
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'GET',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/pet/findByStatus',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractPetApi',
|
|
'userClassname' => 'PetApi',
|
|
'operationId' => 'findPetsByStatus',
|
|
'authMethods' => [
|
|
// oauth2 security schema named 'petstore_auth'
|
|
[
|
|
'type' => 'oauth2',
|
|
'isBasic' => false,
|
|
'isBearer' => false,
|
|
'isApiKey' => false,
|
|
'isOAuth' => true,
|
|
'scopes' => [
|
|
'write:pets', // modify pets in your account
|
|
'read:pets', // read your pets
|
|
],
|
|
],
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'GET',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/pet/findByTags',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractPetApi',
|
|
'userClassname' => 'PetApi',
|
|
'operationId' => 'findPetsByTags',
|
|
'authMethods' => [
|
|
// oauth2 security schema named 'petstore_auth'
|
|
[
|
|
'type' => 'oauth2',
|
|
'isBasic' => false,
|
|
'isBearer' => false,
|
|
'isApiKey' => false,
|
|
'isOAuth' => true,
|
|
'scopes' => [
|
|
'write:pets', // modify pets in your account
|
|
'read:pets', // read your pets
|
|
],
|
|
],
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'PUT',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/pet',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractPetApi',
|
|
'userClassname' => 'PetApi',
|
|
'operationId' => 'updatePet',
|
|
'authMethods' => [
|
|
// oauth2 security schema named 'petstore_auth'
|
|
[
|
|
'type' => 'oauth2',
|
|
'isBasic' => false,
|
|
'isBearer' => false,
|
|
'isApiKey' => false,
|
|
'isOAuth' => true,
|
|
'scopes' => [
|
|
'write:pets', // modify pets in your account
|
|
'read:pets', // read your pets
|
|
],
|
|
],
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'DELETE',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/pet/{petId}',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractPetApi',
|
|
'userClassname' => 'PetApi',
|
|
'operationId' => 'deletePet',
|
|
'authMethods' => [
|
|
// oauth2 security schema named 'petstore_auth'
|
|
[
|
|
'type' => 'oauth2',
|
|
'isBasic' => false,
|
|
'isBearer' => false,
|
|
'isApiKey' => false,
|
|
'isOAuth' => true,
|
|
'scopes' => [
|
|
'write:pets', // modify pets in your account
|
|
'read:pets', // read your pets
|
|
],
|
|
],
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'GET',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/pet/{petId}',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractPetApi',
|
|
'userClassname' => 'PetApi',
|
|
'operationId' => 'getPetById',
|
|
'authMethods' => [
|
|
// apiKey security schema named 'api_key'
|
|
[
|
|
'type' => 'apiKey',
|
|
'isBasic' => false,
|
|
'isBearer' => false,
|
|
'isApiKey' => true,
|
|
'isOAuth' => false,
|
|
'keyParamName' => 'api_key',
|
|
'isKeyInHeader' => true,
|
|
'isKeyInQuery' => false,
|
|
'isKeyInCookie' => false,
|
|
],
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'POST',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/pet/{petId}',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractPetApi',
|
|
'userClassname' => 'PetApi',
|
|
'operationId' => 'updatePetWithForm',
|
|
'authMethods' => [
|
|
// oauth2 security schema named 'petstore_auth'
|
|
[
|
|
'type' => 'oauth2',
|
|
'isBasic' => false,
|
|
'isBearer' => false,
|
|
'isApiKey' => false,
|
|
'isOAuth' => true,
|
|
'scopes' => [
|
|
'write:pets', // modify pets in your account
|
|
'read:pets', // read your pets
|
|
],
|
|
],
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'POST',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/pet/{petId}/uploadImage',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractPetApi',
|
|
'userClassname' => 'PetApi',
|
|
'operationId' => 'uploadFile',
|
|
'authMethods' => [
|
|
// oauth2 security schema named 'petstore_auth'
|
|
[
|
|
'type' => 'oauth2',
|
|
'isBasic' => false,
|
|
'isBearer' => false,
|
|
'isApiKey' => false,
|
|
'isOAuth' => true,
|
|
'scopes' => [
|
|
'write:pets', // modify pets in your account
|
|
'read:pets', // read your pets
|
|
],
|
|
],
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'POST',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/fake/{petId}/uploadImageWithRequiredFile',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractPetApi',
|
|
'userClassname' => 'PetApi',
|
|
'operationId' => 'uploadFileWithRequiredFile',
|
|
'authMethods' => [
|
|
// oauth2 security schema named 'petstore_auth'
|
|
[
|
|
'type' => 'oauth2',
|
|
'isBasic' => false,
|
|
'isBearer' => false,
|
|
'isApiKey' => false,
|
|
'isOAuth' => true,
|
|
'scopes' => [
|
|
'write:pets', // modify pets in your account
|
|
'read:pets', // read your pets
|
|
],
|
|
],
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'GET',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/store/inventory',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractStoreApi',
|
|
'userClassname' => 'StoreApi',
|
|
'operationId' => 'getInventory',
|
|
'authMethods' => [
|
|
// apiKey security schema named 'api_key'
|
|
[
|
|
'type' => 'apiKey',
|
|
'isBasic' => false,
|
|
'isBearer' => false,
|
|
'isApiKey' => true,
|
|
'isOAuth' => false,
|
|
'keyParamName' => 'api_key',
|
|
'isKeyInHeader' => true,
|
|
'isKeyInQuery' => false,
|
|
'isKeyInCookie' => false,
|
|
],
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'POST',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/store/order',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractStoreApi',
|
|
'userClassname' => 'StoreApi',
|
|
'operationId' => 'placeOrder',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'DELETE',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/store/order/{order_id}',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractStoreApi',
|
|
'userClassname' => 'StoreApi',
|
|
'operationId' => 'deleteOrder',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'GET',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/store/order/{order_id}',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractStoreApi',
|
|
'userClassname' => 'StoreApi',
|
|
'operationId' => 'getOrderById',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'POST',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/user',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractUserApi',
|
|
'userClassname' => 'UserApi',
|
|
'operationId' => 'createUser',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'POST',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/user/createWithArray',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractUserApi',
|
|
'userClassname' => 'UserApi',
|
|
'operationId' => 'createUsersWithArrayInput',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'POST',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/user/createWithList',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractUserApi',
|
|
'userClassname' => 'UserApi',
|
|
'operationId' => 'createUsersWithListInput',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'GET',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/user/login',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractUserApi',
|
|
'userClassname' => 'UserApi',
|
|
'operationId' => 'loginUser',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'GET',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/user/logout',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractUserApi',
|
|
'userClassname' => 'UserApi',
|
|
'operationId' => 'logoutUser',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'DELETE',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/user/{username}',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractUserApi',
|
|
'userClassname' => 'UserApi',
|
|
'operationId' => 'deleteUser',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'GET',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/user/{username}',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractUserApi',
|
|
'userClassname' => 'UserApi',
|
|
'operationId' => 'getUserByName',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
[
|
|
'httpMethod' => 'PUT',
|
|
'basePathWithoutHost' => '/v2',
|
|
'path' => '/user/{username}',
|
|
'apiPackage' => 'OpenAPIServer\Api',
|
|
'classname' => 'AbstractUserApi',
|
|
'userClassname' => 'UserApi',
|
|
'operationId' => 'updateUser',
|
|
'authMethods' => [
|
|
],
|
|
],
|
|
];
|
|
|
|
/**
|
|
* Class constructor
|
|
*
|
|
* @param ContainerInterface|array $settings Either a ContainerInterface or an associative array of app settings
|
|
*
|
|
* @throws Exception When implementation class doesn't exists
|
|
*/
|
|
public function __construct($settings = [])
|
|
{
|
|
if ($settings instanceof ContainerInterface) {
|
|
// Set container to create App with on AppFactory
|
|
AppFactory::setContainer($settings);
|
|
}
|
|
$this->slimApp = AppFactory::create();
|
|
|
|
// middlewares requires Psr\Container\ContainerInterface
|
|
$container = $this->slimApp->getContainer();
|
|
|
|
$authPackage = 'OpenAPIServer\Auth';
|
|
$basicAuthenticator = function (ServerRequestInterface &$request, TokenSearch $tokenSearch) use ($authPackage) {
|
|
$message = "How about extending AbstractAuthenticator class by {$authPackage}\BasicAuthenticator?";
|
|
throw new Exception($message);
|
|
};
|
|
$apiKeyAuthenticator = function (ServerRequestInterface &$request, TokenSearch $tokenSearch) use ($authPackage) {
|
|
$message = "How about extending AbstractAuthenticator class by {$authPackage}\ApiKeyAuthenticator?";
|
|
throw new Exception($message);
|
|
};
|
|
$oAuthAuthenticator = function (ServerRequestInterface &$request, TokenSearch $tokenSearch) use ($authPackage) {
|
|
$message = "How about extending AbstractAuthenticator class by {$authPackage}\OAuthAuthenticator?";
|
|
throw new Exception($message);
|
|
};
|
|
|
|
$userOptions = null;
|
|
if ($settings instanceof ContainerInterface && $settings->has('tokenAuthenticationOptions')) {
|
|
$userOptions = $settings->get('tokenAuthenticationOptions');
|
|
} elseif (is_array($settings) && isset($settings['tokenAuthenticationOptions'])) {
|
|
$userOptions = $settings['tokenAuthenticationOptions'];
|
|
}
|
|
|
|
foreach ($this->operations as $operation) {
|
|
$callback = function ($request, $response, $arguments) use ($operation) {
|
|
$message = "How about extending {$operation['classname']} by {$operation['apiPackage']}\\{$operation['userClassname']} class implementing {$operation['operationId']} as a {$operation['httpMethod']} method?";
|
|
throw new Exception($message);
|
|
$response->getBody()->write($message);
|
|
return $response->withStatus(501);
|
|
};
|
|
$middlewares = [new JsonBodyParserMiddleware()];
|
|
|
|
if (class_exists("\\{$operation['apiPackage']}\\{$operation['userClassname']}")) {
|
|
$callback = "\\{$operation['apiPackage']}\\{$operation['userClassname']}:{$operation['operationId']}";
|
|
}
|
|
|
|
foreach ($operation['authMethods'] as $authMethod) {
|
|
switch ($authMethod['type']) {
|
|
case 'http':
|
|
$authenticatorClassname = "\\{$authPackage}\\BasicAuthenticator";
|
|
if (class_exists($authenticatorClassname)) {
|
|
$basicAuthenticator = new $authenticatorClassname($container);
|
|
}
|
|
|
|
$middlewares[] = new TokenAuthentication($this->getTokenAuthenticationOptions([
|
|
'authenticator' => $basicAuthenticator,
|
|
'regex' => $authMethod['isBearer'] ? '/Bearer\s+(.*)$/i' : '/Basic\s+(.*)$/i',
|
|
'header' => 'Authorization',
|
|
'parameter' => null,
|
|
'cookie' => null,
|
|
'argument' => null,
|
|
], $userOptions));
|
|
break;
|
|
case 'apiKey':
|
|
$authenticatorClassname = "\\{$authPackage}\\ApiKeyAuthenticator";
|
|
if (class_exists($authenticatorClassname)) {
|
|
$apiKeyAuthenticator = new $authenticatorClassname($container);
|
|
}
|
|
|
|
$middlewares[] = new TokenAuthentication($this->getTokenAuthenticationOptions([
|
|
'authenticator' => $apiKeyAuthenticator,
|
|
'regex' => '/^(.*)$/i',
|
|
'header' => $authMethod['isKeyInHeader'] ? $authMethod['keyParamName'] : null,
|
|
'parameter' => $authMethod['isKeyInQuery'] ? $authMethod['keyParamName'] : null,
|
|
'cookie' => $authMethod['isKeyInCookie'] ? $authMethod['keyParamName'] : null,
|
|
'argument' => null,
|
|
], $userOptions));
|
|
break;
|
|
case 'oauth2':
|
|
$authenticatorClassname = "\\{$authPackage}\\OAuthAuthenticator";
|
|
if (class_exists($authenticatorClassname)) {
|
|
$oAuthAuthenticator = new $authenticatorClassname($container, $authMethod['scopes']);
|
|
}
|
|
|
|
$middlewares[] = new TokenAuthentication($this->getTokenAuthenticationOptions([
|
|
'authenticator' => $oAuthAuthenticator,
|
|
'regex' => '/Bearer\s+(.*)$/i',
|
|
'header' => 'Authorization',
|
|
'parameter' => null,
|
|
'cookie' => null,
|
|
'argument' => null,
|
|
], $userOptions));
|
|
break;
|
|
default:
|
|
throw new Exception('Unknown authorization schema type');
|
|
}
|
|
}
|
|
|
|
$this->addRoute(
|
|
[$operation['httpMethod']],
|
|
"{$operation['basePathWithoutHost']}{$operation['path']}",
|
|
$callback,
|
|
$middlewares
|
|
)->setName($operation['operationId']);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Merges user defined options with dynamic params
|
|
*
|
|
* @param array $staticOptions Required static options
|
|
* @param array $userOptions User options
|
|
*
|
|
* @return array Merged array
|
|
*/
|
|
private function getTokenAuthenticationOptions(array $staticOptions, array $userOptions = null)
|
|
{
|
|
if (is_array($userOptions) === false) {
|
|
return $staticOptions;
|
|
}
|
|
|
|
return array_merge($userOptions, $staticOptions);
|
|
}
|
|
|
|
/**
|
|
* Add route with multiple methods
|
|
*
|
|
* @param string[] $methods Numeric array of HTTP method names
|
|
* @param string $pattern The route URI pattern
|
|
* @param callable|string $callable The route callback routine
|
|
* @param array|null $middlewares List of middlewares
|
|
*
|
|
* @return RouteInterface
|
|
*
|
|
* @throws InvalidArgumentException If the route pattern isn't a string
|
|
*/
|
|
public function addRoute(array $methods, string $pattern, $callable, $middlewares = [])
|
|
{
|
|
$route = $this->slimApp->map($methods, $pattern, $callable);
|
|
foreach ($middlewares as $middleware) {
|
|
$route->add($middleware);
|
|
}
|
|
return $route;
|
|
}
|
|
|
|
/**
|
|
* Returns Slim Framework instance
|
|
*
|
|
* @return App
|
|
*/
|
|
public function getSlimApp()
|
|
{
|
|
return $this->slimApp;
|
|
}
|
|
}
|