api-platform / api-platform/core

Ability to override/configure OpenAPI servers

Ouverte
#8,029 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
OpenAPI
Langage dominant
PHP
Étoiles
2.6k
Forks
980
Merge moyen
2 j 2 h
PR mergées (30 j)
51

Description

**Description**
I would like to be able to define a list of specific server endpoints (environments) against which my OpenAPI schema can operate against.

**Example**
I should be able to use a decorator to override the default servers listing so that I can have a list of servers within my openapi.json schema export. For example:

```
final class JwtDecorator implements OpenApiFactoryInterface
{
public function __construct(
private OpenApiFactoryInterface $decorated
) {
}

public function __invoke(array $context = []): OpenApi
{
$context['servers'] = [
new Model\Server('https://docker.local/', 'Docker'),
new Model\Server('https://app-dev.company.com/', 'Dev'),
new Model\Server('https://app-staging.company.com/', 'Staging'),
new Model\Server('https://app.company.com/', 'Production'),
];
return ($this->decorated)($context);
}
}
```

After running the export:
`./bin/console api:openapi:export --output=openapi.json`

And upon reviewing the openapi.json file:
```
{
"openapi": "3.0.3",
"info": {
"title": "App",
"description": "description",
"version": "version"
},
"servers": [
{
"url": "https://docker.local/",
"description": "Docker"
},
{
"url": "https://app-dev.company.com/",
"description": "Dev"
},
{
"url": "https://app-staging.company.com/",
"description": "Staging"
},
{
"url": "https://app.company.com/",
"description": "Production"
}
]
```

![image](https://user-images.githubusercontent.com/1039875/137376147-0928a273-b59f-462e-9d2c-9beff291729c.png)

Guide de contribution

Ouvrir le guide de contribution

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.