forked from loafle/openapi-generator-original
45 lines
8.1 KiB
HTML
45 lines
8.1 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>generators/csharp · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<hr>
|
|
"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="generators/csharp · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/index.html"/><meta property="og:description" content="<hr>
|
|
"/><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><link rel="stylesheet" href="/css/main.css"/></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"><div class="wrapper"><div class="post"><header class="postHeader"><h1 class="postHeaderTitle">generators/csharp</h1></header><article><div><span><hr>
|
|
<p>id: generator-opts-client-csharp
|
|
title: Config Options for csharp
|
|
sidebar_label: csharp</p>
|
|
<hr>
|
|
<table>
|
|
<thead>
|
|
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr><td>packageName</td><td>C# package name (convention: Title.Case).</td><td></td><td>Org.OpenAPITools</td></tr>
|
|
<tr><td>packageVersion</td><td>C# package version.</td><td></td><td>1.0.0</td></tr>
|
|
<tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>src</td></tr>
|
|
<tr><td>packageGuid</td><td>The GUID that will be associated with the C# project</td><td></td><td>null</td></tr>
|
|
<tr><td>interfacePrefix</td><td>Prefix interfaces with a community standard or widely accepted prefix.</td><td></td><td>I</td></tr>
|
|
<tr><td>targetFramework</td><td>The target .NET framework version.</td><td><dl><dt><strong>v3.5</strong></dt><dd>.NET Framework 3.5 compatible</dd><dt><strong>v4.0</strong></dt><dd>.NET Framework 4.0 compatible</dd><dt><strong>v4.5</strong></dt><dd>.NET Framework 4.5+ compatible</dd><dt><strong>v5.0</strong></dt><dd>.NET Standard 1.3 compatible</dd><dt><strong>uwp</strong></dt><dd>Universal Windows Platform (IMPORTANT: this will be decommissioned and replaced by v5.0)</dd><dl></td><td>v4.5</td></tr>
|
|
<tr><td>modelPropertyNaming</td><td>Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name</td><td></td><td>PascalCase</td></tr>
|
|
<tr><td>hideGenerationTimestamp</td><td>Hides the generation timestamp when files are generated.</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>useDateTimeOffset</td><td>Use DateTimeOffset to model date-time properties</td><td></td><td>false</td></tr>
|
|
<tr><td>useCollection</td><td>Deserialize array types to Collection<T> instead of List<T>.</td><td></td><td>false</td></tr>
|
|
<tr><td>returnICollection</td><td>Return ICollection<T> instead of the concrete type.</td><td></td><td>false</td></tr>
|
|
<tr><td>optionalMethodArgument</td><td>C# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).</td><td></td><td>true</td></tr>
|
|
<tr><td>optionalAssemblyInfo</td><td>Generate AssemblyInfo.cs.</td><td></td><td>true</td></tr>
|
|
<tr><td>optionalProjectFile</td><td>Generate {PackageName}.csproj.</td><td></td><td>true</td></tr>
|
|
<tr><td>optionalEmitDefaultValues</td><td>Set DataMember's EmitDefaultValue.</td><td></td><td>false</td></tr>
|
|
<tr><td>generatePropertyChanged</td><td>Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.</td><td></td><td>false</td></tr>
|
|
<tr><td>nonPublicApi</td><td>Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.</td><td></td><td>false</td></tr>
|
|
<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>netCoreProjectFile</td><td>Use the new format (.NET Core) for .NET project files (.csproj).</td><td></td><td>false</td></tr>
|
|
<tr><td>validatable</td><td>Generates self-validatable models.</td><td></td><td>true</td></tr>
|
|
<tr><td>useCompareNetObjects</td><td>Use KellermanSoftware.CompareNetObjects for deep recursive object comparison. WARNING: this option incurs potential performance impact.</td><td></td><td>false</td></tr>
|
|
</tbody>
|
|
</table>
|
|
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-1-18</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"></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://gitter.im/OpenAPITools/openapi-generator">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 © 2019 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> |