|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* This file is part of the Spryker Commerce OS. |
|
5
|
|
|
* For full license information, please view the LICENSE file that was distributed with this source code. |
|
6
|
|
|
*/ |
|
7
|
|
|
|
|
8
|
|
|
namespace Pyz\Glue\DocumentationGeneratorApi; |
|
9
|
|
|
|
|
10
|
|
|
use Spryker\Glue\DocumentationGeneratorApi\DocumentationGeneratorApiDependencyProvider as SprykerDocumentationGeneratorApiDependencyProvider; |
|
11
|
|
|
use Spryker\Glue\DocumentationGeneratorApi\Expander\ContextExpanderCollectionInterface; |
|
12
|
|
|
use Spryker\Glue\DocumentationGeneratorApiExtension\Dependency\Plugin\ContentGeneratorStrategyPluginInterface; |
|
13
|
|
|
use Spryker\Glue\DocumentationGeneratorOpenApi\Plugin\DocumentationGeneratorApi\ControllerAnnotationsContextExpanderPlugin; |
|
14
|
|
|
use Spryker\Glue\DocumentationGeneratorOpenApi\Plugin\DocumentationGeneratorApi\CustomRouteControllerAnnotationsContextExpanderPlugin; |
|
15
|
|
|
use Spryker\Glue\DocumentationGeneratorOpenApi\Plugin\DocumentationGeneratorApi\DocumentationGeneratorOpenApiContentGeneratorStrategyPlugin; |
|
16
|
|
|
use Spryker\Glue\DocumentationGeneratorOpenApi\Plugin\DocumentationGeneratorApi\DocumentationGeneratorOpenApiSchemaFormatterPlugin; |
|
17
|
|
|
use Spryker\Glue\DocumentationGeneratorOpenApi\Plugin\DocumentationGeneratorApi\RelationshipPluginAnnotationsContextExpanderPlugin; |
|
18
|
|
|
use Spryker\Glue\GlueApplication\Plugin\DocumentationGeneratorApi\RestApiSchemaFormatterPlugin; |
|
19
|
|
|
use Spryker\Glue\GlueBackendApiApplication\Plugin\DocumentationGeneratorApi\BackendApiApplicationProviderPlugin; |
|
20
|
|
|
use Spryker\Glue\GlueBackendApiApplication\Plugin\DocumentationGeneratorApi\BackendCustomRoutesContextExpanderPlugin; |
|
21
|
|
|
use Spryker\Glue\GlueBackendApiApplication\Plugin\DocumentationGeneratorApi\BackendHostContextExpanderPlugin; |
|
22
|
|
|
use Spryker\Glue\GlueBackendApiApplication\Plugin\DocumentationGeneratorApi\BackendResourcesContextExpanderPlugin; |
|
23
|
|
|
use Spryker\Glue\GlueBackendApiApplicationAuthorizationConnector\Plugin\DocumentationGeneratorApi\AuthorizationContextExpanderPlugin as BackendAuthorizationContextExpanderPlugin; |
|
24
|
|
|
use Spryker\Glue\GlueJsonApiConvention\Plugin\DocumentationGeneratorApi\JsonApiSchemaFormatterPlugin; |
|
25
|
|
|
use Spryker\Glue\GlueStorefrontApiApplication\Plugin\DocumentationGeneratorApi\StorefrontApiApplicationProviderPlugin; |
|
26
|
|
|
use Spryker\Glue\GlueStorefrontApiApplication\Plugin\DocumentationGeneratorApi\StorefrontCustomRoutesContextExpanderPlugin; |
|
27
|
|
|
use Spryker\Glue\GlueStorefrontApiApplication\Plugin\DocumentationGeneratorApi\StorefrontHostContextExpanderPlugin; |
|
28
|
|
|
use Spryker\Glue\GlueStorefrontApiApplication\Plugin\DocumentationGeneratorApi\StorefrontResourcesContextExpanderPlugin; |
|
29
|
|
|
use Spryker\Glue\GlueStorefrontApiApplicationAuthorizationConnector\Plugin\DocumentationGeneratorApi\AuthorizationContextExpanderPlugin as StorefrontAuthorizationContextExpanderPlugin; |
|
30
|
|
|
use Spryker\Glue\GlueStorefrontApiApplicationGlueJsonApiConventionConnector\Plugin\GlueStorefrontApiApplication\RelationshipPluginsContextExpanderPlugin; |
|
31
|
|
|
|
|
32
|
|
|
class DocumentationGeneratorApiDependencyProvider extends SprykerDocumentationGeneratorApiDependencyProvider |
|
33
|
|
|
{ |
|
34
|
|
|
/** |
|
35
|
|
|
* @var string |
|
36
|
|
|
*/ |
|
37
|
|
|
protected const GLUE_BACKEND_API_APPLICATION_NAME = 'backend'; |
|
38
|
|
|
|
|
39
|
|
|
/** |
|
40
|
|
|
* @var string |
|
41
|
|
|
*/ |
|
42
|
|
|
protected const GLUE_STOREFRONT_API_APPLICATION_NAME = 'storefront'; |
|
43
|
|
|
|
|
44
|
|
|
/** |
|
45
|
|
|
* @return array<\Spryker\Glue\DocumentationGeneratorApiExtension\Dependency\Plugin\ApiApplicationProviderPluginInterface> |
|
46
|
|
|
*/ |
|
47
|
|
|
protected function getApiApplicationProviderPlugins(): array |
|
48
|
|
|
{ |
|
49
|
|
|
return [ |
|
50
|
|
|
new StorefrontApiApplicationProviderPlugin(), |
|
51
|
|
|
new BackendApiApplicationProviderPlugin(), |
|
52
|
|
|
]; |
|
53
|
|
|
} |
|
54
|
|
|
|
|
55
|
|
|
/** |
|
56
|
|
|
* @return array<\Spryker\Glue\DocumentationGeneratorApiExtension\Dependency\Plugin\SchemaFormatterPluginInterface> |
|
57
|
|
|
*/ |
|
58
|
|
|
protected function getSchemaFormatterPlugins(): array |
|
59
|
|
|
{ |
|
60
|
|
|
return [ |
|
61
|
|
|
new DocumentationGeneratorOpenApiSchemaFormatterPlugin(), |
|
62
|
|
|
new JsonApiSchemaFormatterPlugin(), |
|
63
|
|
|
new RestApiSchemaFormatterPlugin(), |
|
64
|
|
|
]; |
|
65
|
|
|
} |
|
66
|
|
|
|
|
67
|
|
|
/** |
|
68
|
|
|
* @param \Spryker\Glue\DocumentationGeneratorApi\Expander\ContextExpanderCollectionInterface $contextExpanderCollection |
|
69
|
|
|
* |
|
70
|
|
|
* @return \Spryker\Glue\DocumentationGeneratorApi\Expander\ContextExpanderCollectionInterface |
|
71
|
|
|
*/ |
|
72
|
|
|
protected function getContextExpanderPlugins(ContextExpanderCollectionInterface $contextExpanderCollection): ContextExpanderCollectionInterface |
|
73
|
|
|
{ |
|
74
|
|
|
$apiApplications = []; |
|
75
|
|
|
foreach ($this->getApiApplicationProviderPlugins() as $apiApplicationProviderPlugin) { |
|
76
|
|
|
$apiApplications[] = $apiApplicationProviderPlugin->getName(); |
|
77
|
|
|
} |
|
78
|
|
|
$contextExpanderCollection->addApplications($apiApplications); |
|
79
|
|
|
|
|
80
|
|
|
$contextExpanderCollection->addExpander(new StorefrontResourcesContextExpanderPlugin(), [static::GLUE_STOREFRONT_API_APPLICATION_NAME]); |
|
81
|
|
|
$contextExpanderCollection->addExpander(new StorefrontCustomRoutesContextExpanderPlugin(), [static::GLUE_STOREFRONT_API_APPLICATION_NAME]); |
|
82
|
|
|
$contextExpanderCollection->addExpander(new RelationshipPluginsContextExpanderPlugin(), [static::GLUE_STOREFRONT_API_APPLICATION_NAME]); |
|
83
|
|
|
$contextExpanderCollection->addExpander(new BackendResourcesContextExpanderPlugin(), [static::GLUE_BACKEND_API_APPLICATION_NAME]); |
|
84
|
|
|
$contextExpanderCollection->addExpander(new BackendCustomRoutesContextExpanderPlugin(), [static::GLUE_BACKEND_API_APPLICATION_NAME]); |
|
85
|
|
|
$contextExpanderCollection->addExpander(new ControllerAnnotationsContextExpanderPlugin()); |
|
86
|
|
|
$contextExpanderCollection->addExpander(new CustomRouteControllerAnnotationsContextExpanderPlugin()); |
|
87
|
|
|
$contextExpanderCollection->addExpander(new RelationshipPluginAnnotationsContextExpanderPlugin(), [static::GLUE_STOREFRONT_API_APPLICATION_NAME]); |
|
88
|
|
|
$contextExpanderCollection->addExpander(new BackendHostContextExpanderPlugin(), [static::GLUE_BACKEND_API_APPLICATION_NAME]); |
|
89
|
|
|
$contextExpanderCollection->addExpander(new StorefrontHostContextExpanderPlugin(), [static::GLUE_STOREFRONT_API_APPLICATION_NAME]); |
|
90
|
|
|
$contextExpanderCollection->addExpander(new StorefrontAuthorizationContextExpanderPlugin(), [static::GLUE_STOREFRONT_API_APPLICATION_NAME]); |
|
91
|
|
|
$contextExpanderCollection->addExpander(new BackendAuthorizationContextExpanderPlugin(), [static::GLUE_BACKEND_API_APPLICATION_NAME]); |
|
92
|
|
|
|
|
93
|
|
|
return $contextExpanderCollection; |
|
94
|
|
|
} |
|
95
|
|
|
|
|
96
|
|
|
/** |
|
97
|
|
|
* @return \Spryker\Glue\DocumentationGeneratorApiExtension\Dependency\Plugin\ContentGeneratorStrategyPluginInterface |
|
98
|
|
|
*/ |
|
99
|
|
|
protected function getContentGeneratorStrategyPlugin(): ContentGeneratorStrategyPluginInterface |
|
100
|
|
|
{ |
|
101
|
|
|
return new DocumentationGeneratorOpenApiContentGeneratorStrategyPlugin(); |
|
102
|
|
|
} |
|
103
|
|
|
} |
|
104
|
|
|
|