Skip to content

Commit

Permalink
[phpnextgen] Add API interfaces generation
Browse files Browse the repository at this point in the history
  • Loading branch information
@ybelenko
ybelenko committed Apr 21, 2024
1 parent ed312fc commit a149913
Show file tree
Hide file tree
Showing 18 changed files with 5,339 additions and 2,815 deletions.
2 changes: 2 additions & 0 deletions ...i-generator/src/main/java/org/openapitools/codegen/languages/PhpNextgenClientCodegen.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ public PhpNextgenClientCodegen() {
setSrcBasePath("src");
setTestBasePath("tests");

apiTemplateFiles.put("api_interface.mustache", "Interface.php");

// mark as beta so far
this.generatorMetadata = GeneratorMetadata.newBuilder(generatorMetadata)
.stability(Stability.BETA).build();
Expand Down
270 changes: 9 additions & 261 deletions modules/openapi-generator/src/main/resources/php-nextgen/api.mustache
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ use {{invokerPackage}}\ObjectSerializer;
* @author OpenAPI Generator team
* @link https://openapi-generator.tech
*/
{{#operations}}class {{classname}}
{{#operations}}class {{classname}} implements {{interfaceNamePrefix}}{{classname}}{{interfaceNameSuffix}}
{
/**
* @var ClientInterface
Expand All @@ -60,15 +60,6 @@ use {{invokerPackage}}\ObjectSerializer;
*/
protected int $hostIndex;
/** @var string[] $contentTypes **/
public const contentTypes = [{{#operation}}
'{{{operationId}}}' => [{{#consumes}}
'{{{mediaType}}}',{{/consumes}}
{{^consumes}}
'application/json',
{{/consumes}} ],{{/operation}}
];

/**
* @param ClientInterface|null $client
* @param Configuration|null $config
Expand All @@ -88,27 +79,23 @@ use {{invokerPackage}}\ObjectSerializer;
}

/**
* Set the host index
*
* @param int $hostIndex Host index (required)
* {@inheritdoc}
*/
public function setHostIndex(int $hostIndex): void
{
$this->hostIndex = $hostIndex;
}

/**
* Get the host index
*
* @return int Host index
* {@inheritdoc}
*/
public function getHostIndex(): int
{
return $this->hostIndex;
}

/**
* @return Configuration
* {@inheritdoc}
*/
public function getConfig(): Configuration
{
Expand All @@ -117,57 +104,7 @@ use {{invokerPackage}}\ObjectSerializer;

{{#operation}}
/**
* Operation {{{operationId}}}
{{#summary}}
*
* {{.}}
{{/summary}}
*
{{#description}}
* {{.}}
*
{{/description}}
{{#vendorExtensions.x-group-parameters}}
* Note: the input parameter is an associative array with the keys listed as the parameter name below
*
{{/vendorExtensions.x-group-parameters}}
{{#servers}}
{{#-first}}
* This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host.
* if needed, use the 'variables' parameter to pass variables to the host.
{{/-first}}
* URL: {{{url}}}
{{#variables}}
{{#-first}}
* Variables:
{{/-first}}
* - {{{name}}}: {{{description}}}{{^description}} No description provided{{/description}}{{#enumValues}}
{{#-first}}
* Allowed values:
{{/-first}}
* - {{{.}}}{{/enumValues}}
{{/variables}}
{{#-last}}
*
{{/-last}}
{{/servers}}
{{#allParams}}
* @param {{{dataType}}}{{^required}}|null{{/required}} ${{paramName}}{{#description}} {{.}}{{/description}}{{^description}} {{paramName}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
{{/allParams}}
{{#servers}}
{{#-first}}
* @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
* @param array $variables Associative array of variables to pass to the host. Defaults to empty array.
{{/-first}}
{{/servers}}
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['{{{operationId}}}'] to see the possible values for this operation
*
* @throws ApiException on non-2xx response or if the response body is not in the expected format
* @throws InvalidArgumentException
* @return {{#returnType}}{{#responses}}{{#dataType}}{{^-first}}|{{/-first}}{{/dataType}}{{{dataType}}}{{/responses}}{{/returnType}}{{^returnType}}void{{/returnType}}
{{#isDeprecated}}
* @deprecated
{{/isDeprecated}}
* {@inheritdoc}
*/
public function {{operationId}}(
{{^vendorExtensions.x-group-parameters}}
Expand All @@ -192,57 +129,7 @@ use {{invokerPackage}}\ObjectSerializer;
}

/**
* Operation {{{operationId}}}WithHttpInfo
{{#summary}}
*
* {{.}}
{{/summary}}
*
{{#description}}
* {{.}}
*
{{/description}}
{{#vendorExtensions.x-group-parameters}}
* Note: the input parameter is an associative array with the keys listed as the parameter name below
*
{{/vendorExtensions.x-group-parameters}}
{{#servers}}
{{#-first}}
* This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host.
* if needed, use the 'variables' parameter to pass variables to the host.
{{/-first}}
* URL: {{{url}}}
{{#variables}}
{{#-first}}
* Variables:
{{/-first}}
* - {{{name}}}: {{{description}}}{{^description}} No description provided{{/description}}{{#enumValues}}
{{#-first}}
* Allowed values:
{{/-first}}
* - {{{.}}}{{/enumValues}}
{{/variables}}
{{#-last}}
*
{{/-last}}
{{/servers}}
{{#allParams}}
* @param {{{dataType}}}{{^required}}|null{{/required}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
{{/allParams}}
{{#servers}}
{{#-first}}
* @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
* @param array $variables Associative array of variables to pass to the host. Defaults to empty array.
{{/-first}}
{{/servers}}
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['{{{operationId}}}'] to see the possible values for this operation
*
* @throws ApiException on non-2xx response or if the response body is not in the expected format
* @throws InvalidArgumentException
* @return array of {{#returnType}}{{#responses}}{{#dataType}}{{^-first}}|{{/-first}}{{/dataType}}{{{dataType}}}{{/responses}}{{/returnType}}{{^returnType}}null{{/returnType}}, HTTP status code, HTTP response headers (array of strings)
{{#isDeprecated}}
* @deprecated
{{/isDeprecated}}
* {@inheritdoc}
*/
public function {{operationId}}WithHttpInfo(
{{^vendorExtensions.x-group-parameters}}
Expand Down Expand Up @@ -391,56 +278,7 @@ use {{invokerPackage}}\ObjectSerializer;
}

/**
* Operation {{{operationId}}}Async
*
{{#summary}}
* {{.}}
*
{{/summary}}
{{#description}}
* {{.}}
*
{{/description}}
{{#vendorExtensions.x-group-parameters}}
* Note: the input parameter is an associative array with the keys listed as the parameter name below
*
{{/vendorExtensions.x-group-parameters}}
{{#servers}}
{{#-first}}
* This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host.
* if needed, use the 'variables' parameter to pass variables to the host.
{{/-first}}
* URL: {{{url}}}
{{#variables}}
{{#-first}}
* Variables:
{{/-first}}
* - {{{name}}}: {{{description}}}{{^description}} No description provided{{/description}}{{#enumValues}}
{{#-first}}
* Allowed values:
{{/-first}}
* - {{{.}}}{{/enumValues}}
{{/variables}}
{{#-last}}
*
{{/-last}}
{{/servers}}
{{#allParams}}
* @param {{{dataType}}}{{^required}}|null{{/required}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
{{/allParams}}
{{#servers}}
{{#-first}}
* @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
* @param array $variables Associative array of variables to pass to the host. Defaults to empty array.
{{/-first}}
{{/servers}}
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['{{{operationId}}}'] to see the possible values for this operation
*
* @throws InvalidArgumentException
* @return PromiseInterface
{{#isDeprecated}}
* @deprecated
{{/isDeprecated}}
* {@inheritdoc}
*/
public function {{operationId}}Async(
{{^vendorExtensions.x-group-parameters}}
Expand Down Expand Up @@ -469,56 +307,7 @@ use {{invokerPackage}}\ObjectSerializer;
}

/**
* Operation {{{operationId}}}AsyncWithHttpInfo
*
{{#summary}}
* {{.}}
*
{{/summary}}
{{#description}}
* {{.}}
*
{{/description}}
{{#vendorExtensions.x-group-parameters}}
* Note: the input parameter is an associative array with the keys listed as the parameter name below
*
{{/vendorExtensions.x-group-parameters}}
{{#servers}}
{{#-first}}
* This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host.
* if needed, use the 'variables' parameter to pass variables to the host.
{{/-first}}
* URL: {{{url}}}
{{#variables}}
{{#-first}}
* Variables:
{{/-first}}
* - {{{name}}}: {{{description}}}{{^description}} No description provided{{/description}}{{#enumValues}}
{{#-first}}
* Allowed values:
{{/-first}}
* - {{{.}}}{{/enumValues}}
{{/variables}}
{{#-last}}
*
{{/-last}}
{{/servers}}
{{#allParams}}
* @param {{{dataType}}}{{^required}}|null{{/required}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
{{/allParams}}
{{#servers}}
{{#-first}}
* @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
* @param array $variables Associative array of variables to pass to the host. Defaults to empty array.
{{/-first}}
{{/servers}}
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['{{{operationId}}}'] to see the possible values for this operation
*
* @throws InvalidArgumentException
* @return PromiseInterface
{{#isDeprecated}}
* @deprecated
{{/isDeprecated}}
* {@inheritdoc}
*/
public function {{operationId}}AsyncWithHttpInfo(
{{^vendorExtensions.x-group-parameters}}
Expand Down Expand Up @@ -583,48 +372,7 @@ use {{invokerPackage}}\ObjectSerializer;
}

/**
* Create request for operation '{{{operationId}}}'
*
{{#vendorExtensions.x-group-parameters}}
* Note: the input parameter is an associative array with the keys listed as the parameter name below
*
{{/vendorExtensions.x-group-parameters}}
{{#servers}}
{{#-first}}
* This operation contains host(s) defined in the OpenAPI spec. Use 'hostIndex' to select the host.
* if needed, use the 'variables' parameter to pass variables to the host.
{{/-first}}
* URL: {{{url}}}
{{#variables}}
{{#-first}}
* Variables:
{{/-first}}
* - {{{name}}}: {{{description}}}{{^description}} No description provided{{/description}}{{#enumValues}}
{{#-first}}
* Allowed values:
{{/-first}}
* - {{{.}}}{{/enumValues}}
{{/variables}}
{{#-last}}
*
{{/-last}}
{{/servers}}
{{#allParams}}
* @param {{{dataType}}}{{^required}}|null{{/required}} ${{paramName}}{{#description}} {{.}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
{{/allParams}}
{{#servers}}
{{#-first}}
* @param null|int $hostIndex Host index. Defaults to null. If null, then the library will use $this->hostIndex instead
* @param array $variables Associative array of variables to pass to the host. Defaults to empty array.
{{/-first}}
{{/servers}}
* @param string $contentType The value for the Content-Type header. Check self::contentTypes['{{{operationId}}}'] to see the possible values for this operation
*
* @throws InvalidArgumentException
* @return \GuzzleHttp\Psr7\Request
{{#isDeprecated}}
* @deprecated
{{/isDeprecated}}
* {@inheritdoc}
*/
public function {{operationId}}Request(
{{^vendorExtensions.x-group-parameters}}
Expand Down
Loading

0 comments on commit a149913

Please sign in to comment.