readme.md

RefitGenerator

aka regen

RefitGenerator is a global dotnet tool used to generate Refit client code from OpenApi schemas.

Installation

With .NET 5 installed run: dotnet tool install -g refitgenerator

Usage

Typing regen -h will display a list of parameters:

• -u or --url - url to OpenApi json or yaml
• -f or --file - path to OpenApi json or yaml local file
• -o or --outputDirectory - where to put the generated files
  • defaults to the current directory
• -p or --projectName - project name and root namespace
  • defaults to the output directory name
• --groupBy or --groupingStrategy - method of grouping paths into interfaces
  • defaults to FirstTag
  • possible values
    • FirstTag - uses the first tag in the array for the given path
    • MostCommonTag - uses the most used tag, produces the smallest number of interfaces
    • LeastCommonTag - uses the least used tag, produces the largest number of finely grained interfaces
• -r or --removeIfExists - a flag which controls whether to delete the output directory if exists first
• --executable - generate a .NET 5 console app with a basic setup instead of .NET Standard 2.0 class library
• --ignoreAllHeaders - do not include any header parameters in the resulting code
• --ignoredHeaders - provide a list of headers to ignore, redundant if --ignoreAllHeaders flag is used
• --addEqualsNullToOptionalParameters - if a method parameter is optional, it is generated with a default value of null
• --conflictingNameAffix - adds an affix to a property if its name conflicts with the enclosing type name, not validated whether the resulting property name is a valid identifier
  • defaults to Prop
• --prefixConflictingName - if this flag is set, the --conflictingNameAffix will be a prefix, otherwise it will be a suffix
• --skipDeprecatedProperties - if this flag is set, schema properties marked as Deprecated are not included in the model

Caveats

• This tool does not resolve conflicting type names. For instance, if your schema defines a type which generates a class named Environment, you see an error that System.Environment conflicts with YourNamespace.Models.Environment
• If an object schema has nested, non-reference object schemas, the tool cannot give the nested nice names, so the resulting type name will be ParentType_PropertyName

Dependencies

• System.Commandline for parsing commandline parameters
• OpenAPI.NET - for reading the OpenApi schemas

Try it out

• Github API - causes the conflict described in Caveats
• Petstore - the one and only
• Slack API
• Official examples from spec