github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/openapi-generator/templates/php/api_doc.mustache (about) 1 # {{invokerPackage}}\{{classname}}{{#description}} 2 3 {{description}}{{/description}} 4 5 All URIs are relative to *{{basePath}}* 6 7 Method | HTTP request | Description 8 ------------- | ------------- | ------------- 9 {{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}} 10 {{/operation}}{{/operations}} 11 12 {{#operations}} 13 {{#operation}} 14 15 ## {{{operationId}}} 16 17 > {{#returnType}}{{{returnType}}} {{/returnType}}{{{operationId}}}({{#allParams}}${{paramName}}{{^-last}}, {{/-last}}{{/allParams}}) 18 19 {{{summary}}}{{#notes}} 20 21 {{{notes}}}{{/notes}} 22 23 ### Example 24 25 ```php 26 <?php 27 require_once(__DIR__ . '/vendor/autoload.php'); 28 29 {{> php_doc_auth_partial}} 30 $apiInstance = new {{invokerPackage}}\Api\{{classname}}( 31 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. 32 // This is optional, `GuzzleHttp\Client` will be used as default. 33 new GuzzleHttp\Client(){{#hasAuthMethods}}, 34 $config{{/hasAuthMethods}} 35 ); 36 {{^vendorExtensions.x-group-parameters}} 37 {{#allParams}}${{paramName}} = {{{example}}}; // {{{dataType}}} | {{{description}}} 38 {{/allParams}} 39 {{/vendorExtensions.x-group-parameters}} 40 {{#vendorExtensions.x-group-parameters}} 41 {{#allParams}}$associate_array['{{paramName}}'] = {{{example}}}; // {{{dataType}}} | {{{description}}} 42 {{/allParams}} 43 {{/vendorExtensions.x-group-parameters}} 44 45 try { 46 {{#returnType}}$result = {{/returnType}}$apiInstance->{{{operationId}}}({{^vendorExtensions.x-group-parameters}}{{#allParams}}${{paramName}}{{^-last}}, {{/-last}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}{{#vendorExtensions.x-group-parameters}}$associate_array{{/vendorExtensions.x-group-parameters}});{{#returnType}} 47 print_r($result);{{/returnType}} 48 } catch (Exception $e) { 49 echo 'Exception when calling {{classname}}->{{operationId}}: ', $e->getMessage(), PHP_EOL; 50 } 51 ?> 52 ``` 53 54 ### Parameters 55 56 {{#vendorExtensions.x-group-parameters}} 57 Note: the input parameter is an associative array with the keys listed as the parameter name below. 58 59 {{/vendorExtensions.x-group-parameters}} 60 {{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}} 61 Name | Type | Description | Notes 62 ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}} 63 {{#allParams}} **{{paramName}}** | {{#isFile}}**{{dataType}}**{{/isFile}}{{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{^isFile}}[**{{dataType}}**](../Model/{{baseType}}.md){{/isFile}}{{/isPrimitiveType}}| {{description}} |{{^required}} [optional]{{/required}}{{#defaultValue}} [default to {{defaultValue}}]{{/defaultValue}} 64 {{/allParams}} 65 66 ### Return type 67 68 {{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{{returnType}}}**](../Model/{{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void (empty response body){{/returnType}} 69 70 ### Authorization 71 72 {{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{{name}}}](../../README.md#{{{name}}}){{^-last}}, {{/-last}}{{/authMethods}} 73 74 ### HTTP request headers 75 76 - **Content-Type**: {{#consumes}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}} 77 - **Accept**: {{#produces}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}} 78 79 [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) 80 [[Back to Model list]](../../README.md#documentation-for-models) 81 [[Back to README]](../../README.md) 82 83 {{/operation}} 84 {{/operations}}