forked from loafle/openapi-generator-original
142 lines
12 KiB
HTML
142 lines
12 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for php-slim4 · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for php-slim4 · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||
|
||
ga('create', 'UA-132927057-1', 'auto');
|
||
ga('send', 'pageview');
|
||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||
document.addEventListener('DOMContentLoaded', function() {
|
||
addBackToTop(
|
||
{"zIndex":100}
|
||
)
|
||
});
|
||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for php-slim4</h1></header><article><div><span><table>
|
||
<thead>
|
||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||
<tr><td>apiPackage</td><td>package for generated api classes</td><td></td><td>null</td></tr>
|
||
<tr><td>artifactVersion</td><td>The version to use in the composer package version field. e.g. 1.2.3</td><td></td><td>null</td></tr>
|
||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||
<tr><td>invokerPackage</td><td>The main namespace to use for all classes. e.g. Yay\Pets</td><td></td><td>null</td></tr>
|
||
<tr><td>modelPackage</td><td>package for generated models</td><td></td><td>null</td></tr>
|
||
<tr><td>packageName</td><td>The main package name for classes. e.g. GeneratedPetstore</td><td></td><td>null</td></tr>
|
||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||
<tr><td>psr7Implementation</td><td>Slim 4 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: <a href="https://www.slimframework.com/docs/v4/concepts/value-objects.html">https://www.slimframework.com/docs/v4/concepts/value-objects.html</a></td><td><dl><dt><strong>slim-psr7</strong></dt><dd>Slim PSR-7 Message implementation</dd><dt><strong>nyholm-psr7</strong></dt><dd>Nyholm PSR-7 Message implementation</dd><dt><strong>guzzle-psr7</strong></dt><dd>Guzzle PSR-7 Message implementation</dd><dt><strong>zend-diactoros</strong></dt><dd>Zend Diactoros PSR-7 Message implementation</dd><dl></td><td>slim-psr7</td></tr>
|
||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||
<tr><td>srcBasePath</td><td>The directory to serve as source root.</td><td></td><td>null</td></tr>
|
||
<tr><td>variableNamingConvention</td><td>naming convention of variable name, e.g. camelCase.</td><td></td><td>camelCase</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
</tbody>
|
||
</table>
|
||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td>array</td><td>array</td></tr>
|
||
<tr><td>map</td><td>map</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>DateTime</li>
|
||
<li>bool</li>
|
||
<li>boolean</li>
|
||
<li>byte</li>
|
||
<li>double</li>
|
||
<li>float</li>
|
||
<li>int</li>
|
||
<li>integer</li>
|
||
<li>mixed</li>
|
||
<li>number</li>
|
||
<li>object</li>
|
||
<li>string</li>
|
||
<li>void</li>
|
||
</ul>
|
||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>__halt_compiler</li>
|
||
<li>_header_accept</li>
|
||
<li>_tempbody</li>
|
||
<li>abstract</li>
|
||
<li>and</li>
|
||
<li>array</li>
|
||
<li>as</li>
|
||
<li>break</li>
|
||
<li>callable</li>
|
||
<li>case</li>
|
||
<li>catch</li>
|
||
<li>class</li>
|
||
<li>clone</li>
|
||
<li>const</li>
|
||
<li>continue</li>
|
||
<li>declare</li>
|
||
<li>default</li>
|
||
<li>die</li>
|
||
<li>do</li>
|
||
<li>echo</li>
|
||
<li>else</li>
|
||
<li>elseif</li>
|
||
<li>empty</li>
|
||
<li>enddeclare</li>
|
||
<li>endfor</li>
|
||
<li>endforeach</li>
|
||
<li>endif</li>
|
||
<li>endswitch</li>
|
||
<li>endwhile</li>
|
||
<li>eval</li>
|
||
<li>exit</li>
|
||
<li>extends</li>
|
||
<li>final</li>
|
||
<li>for</li>
|
||
<li>foreach</li>
|
||
<li>formparams</li>
|
||
<li>function</li>
|
||
<li>global</li>
|
||
<li>goto</li>
|
||
<li>headerparams</li>
|
||
<li>httpbody</li>
|
||
<li>if</li>
|
||
<li>implements</li>
|
||
<li>include</li>
|
||
<li>include_once</li>
|
||
<li>instanceof</li>
|
||
<li>insteadof</li>
|
||
<li>interface</li>
|
||
<li>isset</li>
|
||
<li>list</li>
|
||
<li>namespace</li>
|
||
<li>new</li>
|
||
<li>or</li>
|
||
<li>print</li>
|
||
<li>private</li>
|
||
<li>protected</li>
|
||
<li>public</li>
|
||
<li>queryparams</li>
|
||
<li>require</li>
|
||
<li>require_once</li>
|
||
<li>resourcepath</li>
|
||
<li>return</li>
|
||
<li>static</li>
|
||
<li>switch</li>
|
||
<li>throw</li>
|
||
<li>trait</li>
|
||
<li>try</li>
|
||
<li>unset</li>
|
||
<li>use</li>
|
||
<li>var</li>
|
||
<li>while</li>
|
||
<li>xor</li>
|
||
</ul>
|
||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 1/20/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html> |