Refitter

CLI Tool

Installation:

dotnet tool install --global Refitter

Usage:

$ refitter --help

USAGE:    refitter [URL or input file] [OPTIONS]EXAMPLES:    refitter ./openapi.json    refitter https://petstore3.swagger.io/api/v3/openapi.yaml    refitter ./openapi.json --settings-file ./openapi.refitter --output ./GeneratedCode.cs    refitter ./openapi.json --namespace "Your.Namespace.Of.Choice.GeneratedCode" --output ./GeneratedCode.cs    refitter ./openapi.json --namespace "Your.Namespace.Of.Choice.GeneratedCode" --internal    refitter ./openapi.json --output ./IGeneratedCode.cs --interface-only    refitter ./openapi.json --output ./GeneratedContracts.cs --contract-only    refitter ./openapi.json --use-api-response    refitter ./openapi.json --cancellation-tokens    refitter ./openapi.json --no-operation-headers    refitter ./openapi.json --no-accept-headers    refitter ./openapi.json --use-iso-date-format    refitter ./openapi.json --additional-namespace "Your.Additional.Namespace" --additional-namespace "Your.Other.Additional.Namespace"    refitter ./openapi.json --multiple-interfaces ByEndpoint    refitter ./openapi.json --tag Pet --tag Store --tag User    refitter ./openapi.json --match-path '^/pet/.*'    refitter ./openapi.json --trim-unused-schema    refitter ./openapi.json --trim-unused-schema  --keep-schema '^Model$' --keep-schema '^Person.+'    refitter ./openapi.json --no-deprecated-operations    refitter ./openapi.json --operation-name-template '{operationName}Async'    refitter ./openapi.json --optional-nullable-parameters    refitter ./openapi.json --use-polymorphic-serializationARGUMENTS:    [URL or input file]    URL or file path to OpenAPI Specification fileOPTIONS:                                                DEFAULT                                                                                                                                                        -h, --help                                                   Prints help information                                                                                                                       -v, --version                                                Prints version information                                                                                                                    -s, --settings-file                                          Path to .refitter settings file. Specifying this will ignore all other settings (except for --output)                                         -n, --namespace                             GeneratedCode    Default namespace to use for generated types                                                                                                      --contracts-namespace                                    Default namespace to use for generated contracts                                                                                              -o, --output                                Output.cs        Path to Output file or folder (if multiple files are generated)                                                                                   --contracts-output                                       Output path for generated contracts. Enabling this automatically enables generating multiple files                                                --no-auto-generated-header                               Don't add <auto-generated> header to output file                                                                                                  --no-accept-headers                                      Don't add <Accept> header to output file                                                                                                          --interface-only                                         Don't generate contract types                                                                                                                     --contract-only                                          Don't generate clients                                                                                                                            --use-api-response                                       Return Task<IApiResponse<T>> instead of Task<T>                                                                                                   --use-observable-response                                Return IObservable instead of Task                                                                                                                --internal                                               Set the accessibility of the generated types to 'internal'                                                                                        --cancellation-tokens                                    Use cancellation tokens                                                                                                                           --no-operation-headers                                   Don't generate operation headers                                                                                                                  --no-logging                                             Don't log errors or collect telemetry                                                                                                             --additional-namespace                                   Add additional namespace to generated types                                                                                                       --exclude-namespace                                      Exclude namespace on generated types                                                                                                              --use-iso-date-format                                    Explicitly format date query string parameters in ISO 8601 standard date format using delimiters (2023-06-15)                                     --multiple-interfaces                                    Generate a Refit interface for each endpoint. May be one of ByEndpoint, ByTag                                                                     --multiple-files                                         Generate multiple files instead of a single large file.                                                                                                                                                    The output files can be the following:                                                                                                                                                                     - RefitInterfaces.cs                                                                                                                                                                                       - DependencyInjection.cs                                                                                                                                                                                   - Contracts.cs                                                                                                                                    --match-path                                             Only include Paths that match the provided regular expression. May be set multiple times                                                          --tag                                                    Only include Endpoints that contain this tag. May be set multiple times and result in OR'ed evaluation                                            --skip-validation                                        Skip validation of the OpenAPI specification                                                                                                      --no-deprecated-operations                               Don't generate deprecated operations                                                                                                              --operation-name-template                                Generate operation names using pattern. When using --multiple-interfaces ByEndpoint, this is name of the Execute() method in the interface        --optional-nullable-parameters                           Generate nullable parameters as optional parameters                                                                                               --trim-unused-schema                                     Removes unreferenced components schema to keep the generated output to a minimum                                                                  --keep-schema                                            Force to keep matching schema, uses regular expressions. Use together with "--trim-unused-schema". Can be set multiple times                      --no-banner                                              Don't show donation banner                                                                                                                        --skip-default-additional-properties                     Set to true to skip default additional properties                                                                                                 --operation-name-generator              Default          The NSwag IOperationNameGenerator implementation to use.                                                                                                                                                   May be one of:                                                                                                                                                                                             - Default                                                                                                                                                                                                  - MultipleClientsFromOperationId                                                                                                                                                                           - MultipleClientsFromPathSegments                                                                                                                                                                          - MultipleClientsFromFirstTagAndOperationId                                                                                                                                                                - MultipleClientsFromFirstTagAndOperationName                                                                                                                                                              - MultipleClientsFromFirstTagAndPathSegments                                                                                                                                                               - SingleClientFromOperationId                                                                                                                                                                              - SingleClientFromPathSegments                                                                                                                                                                             See https://refitter.github.io/api/Refitter.Core.OperationNameGeneratorTypes.html for more information                                            --immutable-records                                      Generate contracts as immutable records instead of classes                                                                                        --use-apizr                                              Use Apizr by:                                                                                                                                                                                              - Adding a final IApizrRequestOptions options parameter to all generated methods                                                                                                                           - Providing cancellation tokens by Apizr request options instead of a dedicated parameter                                                                                                                  - Using method overloads instead of optional parameters                                                                                                                                                    See https://refitter.github.io for more information and https://www.apizr.net to get started with Apizr                                           --use-dynamic-querystring-parameters                     Enable wrapping multiple query parameters into a single complex one. Default is no wrapping.                                                                                                               See https://github.com/reactiveui/refit?tab=readme-ov-file#dynamic-querystring-parameters for more information                                    --use-polymorphic-serialization                          Use System.Text.Json polymorphic serialization

$ refitter [path to OpenAPI spec file] --namespace"[Your.Namespace.Of.Choice.GeneratedCode]"

Source Generator

Installation

dotnet add package Refitter.SourceGenerator

Usage

.Refitter File format

{"openApiPath":"/path/to/your/openAPI",// Required"namespace":"Org.System.Service.Api.GeneratedCode",// Optional. Default=GeneratedCode"contractsNamespace":"Org.System.Service.Api.GeneratedCode.Contracts",// Optional. Default=GeneratedCode"naming":{"useOpenApiTitle":false,// Optional. Default=true"interfaceName":"MyApiClient"// Optional. Default=ApiClient},"generateContracts":true,// Optional. Default=true"generateClients":true,// Optional. Default=true"generateXmlDocCodeComments":true,// Optional. Default=true"generateStatusCodeComments":true,// Optional. Default=true"addAutoGeneratedHeader":true,// Optional. Default=true"addAcceptHeaders":true,// Optional. Default=true"returnIApiResponse":false,// Optional. Default=false"responseTypeOverride":{// Optional. Default={}"File_Upload":"IApiResponse","File_Download":"System.Net.Http.HttpContent"},"generateOperationHeaders":true,// Optional. Default=true"typeAccessibility":"Public",// Optional. Values=Public|Internal. Default=Public"useCancellationTokens":false,// Optional. Default=false"useIsoDateFormat":false,// Optional. Default=false"multipleInterfaces":"ByEndpoint",// Optional. May be one of "ByEndpoint" or "ByTag""generateDeprecatedOperations":false,// Optional. Default=true"operationNameTemplate":"{operationName}Async",// Optional. Must contain {operationName} when multipleInterfaces != ByEndpoint"optionalParameters":false,// Optional. Default=false"outputFolder":"../CustomOutput"// Optional. Default=./Generated"outputFilename":"RefitInterface.cs",// Optional. Default=Output.cs for CLI tool"contractsOutputFolder":"../Contracts",// Optional. Default=NULL"generateMultipleFiles":false,// Optional. Default=false"additionalNamespaces":[// Optional"Namespace1","Namespace2"],"includeTags":[// Optional. OpenAPI Tag to include when generating code"Pet","Store","User"],"includePathMatches":[// Optional. Only include Paths that match the provided regular expression"^/pet/.*","^/store/.*"],"trimUnusedSchema":false,// Optional. Default=false"keepSchemaPatterns":[// Optional. Force to keep matching schema, uses regular expressions. Use together with trimUnusedSchema=true"^Model$","^Person.+"],"generateDefaultAdditionalProperties":true,// Optional. default=true"operationNameGenerator":"Default",// Optional. May be one of Default, MultipleClientsFromOperationId, MultipleClientsFromPathSegments, MultipleClientsFromFirstTagAndOperationId, MultipleClientsFromFirstTagAndOperationName, MultipleClientsFromFirstTagAndPathSegments, SingleClientFromOperationId, SingleClientFromPathSegments"immutableRecords":false,"useDynamicQuerystringParameters":true,// Optional. Default=false"usePolymorphicSerialization", false,// Optional. Default=false"dependencyInjectionSettings":{// Optional"baseUrl":"https://petstore3.swagger.io/api/v3",// Optional. Leave this blank to set the base address manually"httpMessageHandlers":[// Optional"AuthorizationMessageHandler","TelemetryMessageHandler"],"usePolly":true,// DEPRECATED - Use "transientErrorHandler": "None|Polly|HttpResilience" instead"transientErrorHandler":"HttpResilience",// Optional. Set this to configure transient error handling with a retry policy that uses a jittered backoff. May be one of None, Polly, HttpResilience"maxRetryCount":3,// Optional. Default=6"firstBackoffRetryInSeconds":0.5// Optional. Default=1.0},"apizrSettings":{// Optional"withRequestOptions":true,// Optional. Default=true"withRegistrationHelper":true,// Optional. Default=false"withCacheProvider":"InMemory",// Optional. Values=None|Akavache|MonkeyCache|InMemory|DistributedAsString|DistributedAsByteArray. Default=None"withPriority":true,// Optional. Default=false"withMediation":true,// Optional. Default=false"withOptionalMediation":true,// Optional. Default=false"withMappingProvider":"AutoMapper",// Optional. Values=None|AutoMapper|Mapster. Default=None"withFileTransfer":true// Optional. Default=false},"codeGeneratorSettings":{// Optional. Default settings are the values set in this example"requiredPropertiesMustBeDefined":true,"generateDataAnnotations":true,"anyType":"object","dateType":"System.DateTimeOffset","dateTimeType":"System.DateTimeOffset","timeType":"System.TimeSpan","timeSpanType":"System.TimeSpan","arrayType":"System.Collections.Generic.ICollection","dictionaryType":"System.Collections.Generic.IDictionary","arrayInstanceType":"System.Collections.ObjectModel.Collection","dictionaryInstanceType":"System.Collections.Generic.Dictionary","arrayBaseType":"System.Collections.ObjectModel.Collection","dictionaryBaseType":"System.Collections.Generic.Dictionary","propertySetterAccessModifier":"","generateImmutableArrayProperties":false,"generateImmutableDictionaryProperties":false,"handleReferences":false,"jsonSerializerSettingsTransformationMethod":null,"generateJsonMethods":false,"enforceFlagEnums":false,"inlineNamedDictionaries":false,"inlineNamedTuples":true,"inlineNamedArrays":false,"generateOptionalPropertiesAsNullable":false,"generateNullableReferenceTypes":false,"generateNativeRecords":false,"generateDefaultValues":true,"inlineNamedAny":false,"excludedTypeNames":["ExcludedTypeFoo","ExcludedTypeBar"]}}

Using the generated code

$ refitter ./openapi.json --namespace"Your.Namespace.Of.Choice.GeneratedCode"

{"openApiPath":"./openapi.json","namespace":"Your.Namespace.Of.Choice.GeneratedCode"}

usingRefit;usingSystem.Collections.Generic;usingSystem.Text.Json.Serialization;usingSystem.Threading.Tasks;namespaceYour.Namespace.Of.Choice.GeneratedCode{[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceISwaggerPetstore{/// <summary>Update an existing pet</summary>/// <remarks>Update an existing pet by Id</remarks>/// <param name="body">Update an existent pet in the store</param>/// <returns>Successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid ID supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>Pet not found</description>/// </item>/// <item>/// <term>405</term>/// <description>Validation exception</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/xml, application/json")][Put("/pet")]Task<Pet>UpdatePet([Body]Petbody);/// <summary>Add a new pet to the store</summary>/// <remarks>Add a new pet to the store</remarks>/// <param name="body">Create a new pet in the store</param>/// <returns>Successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>405</term>/// <description>Invalid input</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/xml, application/json")][Post("/pet")]Task<Pet>AddPet([Body]Petbody);/// <summary>Finds Pets by status</summary>/// <remarks>Multiple status values can be provided with comma separated strings</remarks>/// <param name="status">Status values that need to be considered for filter</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid status value</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/json")][Get("/pet/findByStatus")]Task<ICollection<Pet>>FindPetsByStatus([Query]Status?status);/// <summary>Finds Pets by tags</summary>/// <remarks>Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.</remarks>/// <param name="tags">Tags to filter by</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid tag value</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/json")][Get("/pet/findByTags")]Task<ICollection<Pet>>FindPetsByTags([Query(CollectionFormat.Multi)]IEnumerable<string>tags);/// <summary>Find pet by ID</summary>/// <remarks>Returns a single pet</remarks>/// <param name="petId">ID of pet to return</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid ID supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>Pet not found</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/xml, application/json")][Get("/pet/{petId}")]Task<Pet>GetPetById(longpetId);/// <summary>Updates a pet in the store with form data</summary>/// <param name="petId">ID of pet that needs to be updated</param>/// <param name="name">Name of pet that needs to be updated</param>/// <param name="status">Status of pet that needs to be updated</param>/// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>405</term>/// <description>Invalid input</description>/// </item>/// </list>/// </exception>[Post("/pet/{petId}")]TaskUpdatePetWithForm(longpetId,[Query]stringname,[Query]stringstatus);/// <summary>Deletes a pet</summary>/// <param name="petId">Pet id to delete</param>/// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid pet value</description>/// </item>/// </list>/// </exception>[Delete("/pet/{petId}")]TaskDeletePet(longpetId,[Header("api_key")]stringapi_key);/// <summary>uploads an image</summary>/// <param name="petId">ID of pet to update</param>/// <param name="additionalMetadata">Additional Metadata</param>/// <returns>/// A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>200</term>/// <description>successful operation</description>/// </item>/// </list>/// </returns>[Headers("Accept: application/json")][Post("/pet/{petId}/uploadImage")]Task<ApiResponse>UploadFile(longpetId,[Query]stringadditionalMetadata,StreamPartbody);/// <summary>Returns pet inventories by status</summary>/// <remarks>Returns a map of status codes to quantities</remarks>/// <returns>successful operation</returns>/// <exception cref="ApiException">Thrown when the request returns a non-success status code.</exception>[Headers("Accept: application/json")][Get("/store/inventory")]Task<IDictionary<string,int>>GetInventory();/// <summary>Place an order for a pet</summary>/// <remarks>Place a new order in the store</remarks>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>405</term>/// <description>Invalid input</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/json")][Post("/store/order")]Task<Order>PlaceOrder([Body]Orderbody);/// <summary>Find purchase order by ID</summary>/// <remarks>For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions</remarks>/// <param name="orderId">ID of order that needs to be fetched</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid ID supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>Order not found</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/json")][Get("/store/order/{orderId}")]Task<Order>GetOrderById(longorderId);/// <summary>Delete purchase order by ID</summary>/// <remarks>For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors</remarks>/// <param name="orderId">ID of the order that needs to be deleted</param>/// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid ID supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>Order not found</description>/// </item>/// </list>/// </exception>[Delete("/store/order/{orderId}")]TaskDeleteOrder(longorderId);/// <summary>Create user</summary>/// <remarks>This can only be done by the logged in user.</remarks>/// <param name="body">Created user object</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">Thrown when the request returns a non-success status code.</exception>[Headers("Accept: application/json, application/xml")][Post("/user")]TaskCreateUser([Body]Userbody);/// <summary>Creates list of users with given input array</summary>/// <remarks>Creates list of users with given input array</remarks>/// <returns>Successful operation</returns>/// <exception cref="ApiException">Thrown when the request returns a non-success status code.</exception>[Headers("Accept: application/xml, application/json")][Post("/user/createWithList")]Task<User>CreateUsersWithListInput([Body]IEnumerable<User>body);/// <summary>Logs user into the system</summary>/// <param name="username">The user name for login</param>/// <param name="password">The password for login in clear text</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid username/password supplied</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/json")][Get("/user/login")]Task<string>LoginUser([Query]stringusername,[Query]stringpassword);/// <summary>Logs out current logged in user session</summary>/// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>/// <exception cref="ApiException">Thrown when the request returns a non-success status code.</exception>[Get("/user/logout")]TaskLogoutUser();/// <summary>Get user by user name</summary>/// <param name="username">The name that needs to be fetched. Use user1 for testing.</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid username supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>User not found</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/json")][Get("/user/{username}")]Task<User>GetUserByName(stringusername);/// <summary>Update user</summary>/// <remarks>This can only be done by the logged in user.</remarks>/// <param name="username">name that need to be deleted</param>/// <param name="body">Update an existent user in the store</param>/// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>/// <exception cref="ApiException">Thrown when the request returns a non-success status code.</exception>[Put("/user/{username}")]TaskUpdateUser(stringusername,[Body]Userbody);/// <summary>Delete user</summary>/// <remarks>This can only be done by the logged in user.</remarks>/// <param name="username">The name that needs to be deleted</param>/// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid username supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>User not found</description>/// </item>/// </list>/// </exception>[Delete("/user/{username}")]TaskDeleteUser(stringusername);}}

$ refitter ./openapi.json --namespace"Your.Namespace.Of.Choice.GeneratedCode" --use-api-response

{"openApiPath":"./openapi.json","namespace":"Your.Namespace.Of.Choice.GeneratedCode","returnIApiResponse":true}

usingRefit;usingSystem.Collections.Generic;usingSystem.Text.Json.Serialization;usingSystem.Threading.Tasks;namespaceYour.Namespace.Of.Choice.GeneratedCode{[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceISwaggerPetstore{/// <summary>Update an existing pet</summary>/// <remarks>Update an existing pet by Id</remarks>/// <param name="body">Update an existent pet in the store</param>/// <returns>/// A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>200</term>/// <description>Successful operation</description>/// </item>/// <item>/// <term>400</term>/// <description>Invalid ID supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>Pet not found</description>/// </item>/// <item>/// <term>405</term>/// <description>Validation exception</description>/// </item>/// </list>/// </returns>[Headers("Accept: application/xml, application/json")][Put("/pet")]Task<IApiResponse<Pet>>UpdatePet([Body]Petbody);/// <summary>Add a new pet to the store</summary>/// <remarks>Add a new pet to the store</remarks>/// <param name="body">Create a new pet in the store</param>/// <returns>/// A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>200</term>/// <description>Successful operation</description>/// </item>/// <item>/// <term>405</term>/// <description>Invalid input</description>/// </item>/// </list>/// </returns>[Headers("Accept: application/xml, application/json")][Post("/pet")]Task<IApiResponse<Pet>>AddPet([Body]Petbody);/// <summary>Finds Pets by status</summary>/// <remarks>Multiple status values can be provided with comma separated strings</remarks>/// <param name="status">Status values that need to be considered for filter</param>/// <returns>/// A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>200</term>/// <description>successful operation</description>/// </item>/// <item>/// <term>400</term>/// <description>Invalid status value</description>/// </item>/// </list>/// </returns>[Headers("Accept: application/json")][Get("/pet/findByStatus")]Task<IApiResponse<ICollection<Pet>>>FindPetsByStatus([Query]Status?status);/// <summary>Finds Pets by tags</summary>/// <remarks>Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.</remarks>/// <param name="tags">Tags to filter by</param>/// <returns>/// A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>200</term>/// <description>successful operation</description>/// </item>/// <item>/// <term>400</term>/// <description>Invalid tag value</description>/// </item>/// </list>/// </returns>[Headers("Accept: application/json")][Get("/pet/findByTags")]Task<IApiResponse<ICollection<Pet>>>FindPetsByTags([Query(CollectionFormat.Multi)]IEnumerable<string>tags);/// <summary>Find pet by ID</summary>/// <remarks>Returns a single pet</remarks>/// <param name="petId">ID of pet to return</param>/// <returns>/// A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>200</term>/// <description>successful operation</description>/// </item>/// <item>/// <term>400</term>/// <description>Invalid ID supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>Pet not found</description>/// </item>/// </list>/// </returns>[Headers("Accept: application/xml, application/json")][Get("/pet/{petId}")]Task<IApiResponse<Pet>>GetPetById(longpetId);/// <summary>Updates a pet in the store with form data</summary>/// <param name="petId">ID of pet that needs to be updated</param>/// <param name="name">Name of pet that needs to be updated</param>/// <param name="status">Status of pet that needs to be updated</param>/// <returns>/// A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>405</term>/// <description>Invalid input</description>/// </item>/// </list>/// </returns>[Post("/pet/{petId}")]Task<IApiResponse>UpdatePetWithForm(longpetId,[Query]stringname,[Query]stringstatus);/// <summary>Deletes a pet</summary>/// <param name="petId">Pet id to delete</param>/// <returns>/// A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid pet value</description>/// </item>/// </list>/// </returns>[Delete("/pet/{petId}")]Task<IApiResponse>DeletePet(longpetId,[Header("api_key")]stringapi_key);/// <summary>uploads an image</summary>/// <param name="petId">ID of pet to update</param>/// <param name="additionalMetadata">Additional Metadata</param>/// <returns>/// A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>200</term>/// <description>successful operation</description>/// </item>/// </list>/// </returns>[Headers("Accept: application/json")][Post("/pet/{petId}/uploadImage")]Task<IApiResponse<ApiResponse>>UploadFile(longpetId,[Query]stringadditionalMetadata,StreamPartbody);/// <summary>Returns pet inventories by status</summary>/// <remarks>Returns a map of status codes to quantities</remarks>/// <returns>successful operation</returns>/// <exception cref="ApiException">Thrown when the request returns a non-success status code.</exception>[Headers("Accept: application/json")][Get("/store/inventory")]Task<IApiResponse<IDictionary<string,int>>>GetInventory();/// <summary>Place an order for a pet</summary>/// <remarks>Place a new order in the store</remarks>/// <returns>/// A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>200</term>/// <description>successful operation</description>/// </item>/// <item>/// <term>405</term>/// <description>Invalid input</description>/// </item>/// </list>/// </returns>[Headers("Accept: application/json")][Post("/store/order")]Task<IApiResponse<Order>>PlaceOrder([Body]Orderbody);/// <summary>Find purchase order by ID</summary>/// <remarks>For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions</remarks>/// <param name="orderId">ID of order that needs to be fetched</param>/// <returns>/// A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>200</term>/// <description>successful operation</description>/// </item>/// <item>/// <term>400</term>/// <description>Invalid ID supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>Order not found</description>/// </item>/// </list>/// </returns>[Headers("Accept: application/json")][Get("/store/order/{orderId}")]Task<IApiResponse<Order>>GetOrderById(longorderId);/// <summary>Delete purchase order by ID</summary>/// <remarks>For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors</remarks>/// <param name="orderId">ID of the order that needs to be deleted</param>/// <returns>/// A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid ID supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>Order not found</description>/// </item>/// </list>/// </returns>[Delete("/store/order/{orderId}")]Task<IApiResponse>DeleteOrder(longorderId);/// <summary>Create user</summary>/// <remarks>This can only be done by the logged in user.</remarks>/// <param name="body">Created user object</param>/// <returns>A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result.</returns>[Headers("Accept: application/json, application/xml")][Post("/user")]Task<IApiResponse>CreateUser([Body]Userbody);/// <summary>Creates list of users with given input array</summary>/// <remarks>Creates list of users with given input array</remarks>/// <returns>/// A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>200</term>/// <description>Successful operation</description>/// </item>/// </list>/// </returns>[Headers("Accept: application/xml, application/json")][Post("/user/createWithList")]Task<IApiResponse<User>>CreateUsersWithListInput([Body]IEnumerable<User>body);/// <summary>Logs user into the system</summary>/// <param name="username">The user name for login</param>/// <param name="password">The password for login in clear text</param>/// <returns>/// A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>200</term>/// <description>successful operation</description>/// </item>/// <item>/// <term>400</term>/// <description>Invalid username/password supplied</description>/// </item>/// </list>/// </returns>[Headers("Accept: application/json")][Get("/user/login")]Task<IApiResponse<string>>LoginUser([Query]stringusername,[Query]stringpassword);/// <summary>Logs out current logged in user session</summary>/// <returns>A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result.</returns>[Get("/user/logout")]Task<IApiResponse>LogoutUser();/// <summary>Get user by user name</summary>/// <param name="username">The name that needs to be fetched. Use user1 for testing.</param>/// <returns>/// A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>200</term>/// <description>successful operation</description>/// </item>/// <item>/// <term>400</term>/// <description>Invalid username supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>User not found</description>/// </item>/// </list>/// </returns>[Headers("Accept: application/json")][Get("/user/{username}")]Task<IApiResponse<User>>GetUserByName(stringusername);/// <summary>Update user</summary>/// <remarks>This can only be done by the logged in user.</remarks>/// <param name="username">name that need to be deleted</param>/// <param name="body">Update an existent user in the store</param>/// <returns>A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result.</returns>[Put("/user/{username}")]Task<IApiResponse>UpdateUser(stringusername,[Body]Userbody);/// <summary>Delete user</summary>/// <remarks>This can only be done by the logged in user.</remarks>/// <param name="username">The name that needs to be deleted</param>/// <returns>/// A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid username supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>User not found</description>/// </item>/// </list>/// </returns>[Delete("/user/{username}")]Task<IApiResponse>DeleteUser(stringusername);}}

$ refitter ./openapi.json --namespace"Your.Namespace.Of.Choice.GeneratedCode" --multiple-interfaces ByEndpoint

{"openApiPath":"./openapi.json","namespace":"Your.Namespace.Of.Choice.GeneratedCode","multipleInterfaces":"ByEndpoint"}

/// <summary>Update an existing pet</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceIUpdatePetEndpoint{/// <summary>Update an existing pet</summary>/// <remarks>Update an existing pet by Id</remarks>/// <param name="body">Update an existent pet in the store</param>/// <returns>Successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid ID supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>Pet not found</description>/// </item>/// <item>/// <term>405</term>/// <description>Validation exception</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/xml, application/json")][Put("/pet")]Task<Pet>Execute([Body]Petbody);}/// <summary>Add a new pet to the store</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceIAddPetEndpoint{/// <summary>Add a new pet to the store</summary>/// <remarks>Add a new pet to the store</remarks>/// <param name="body">Create a new pet in the store</param>/// <returns>Successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>405</term>/// <description>Invalid input</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/xml, application/json")][Post("/pet")]Task<Pet>Execute([Body]Petbody);}/// <summary>Finds Pets by status</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceIFindPetsByStatusEndpoint{/// <summary>Finds Pets by status</summary>/// <remarks>Multiple status values can be provided with comma separated strings</remarks>/// <param name="status">Status values that need to be considered for filter</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid status value</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/json")][Get("/pet/findByStatus")]Task<ICollection<Pet>>Execute([Query]Status?status);}/// <summary>Finds Pets by tags</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceIFindPetsByTagsEndpoint{/// <summary>Finds Pets by tags</summary>/// <remarks>Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.</remarks>/// <param name="tags">Tags to filter by</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid tag value</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/json")][Get("/pet/findByTags")]Task<ICollection<Pet>>Execute([Query(CollectionFormat.Multi)]IEnumerable<string>tags);}/// <summary>Find pet by ID</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceIGetPetByIdEndpoint{/// <summary>Find pet by ID</summary>/// <remarks>Returns a single pet</remarks>/// <param name="petId">ID of pet to return</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid ID supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>Pet not found</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/xml, application/json")][Get("/pet/{petId}")]Task<Pet>Execute(longpetId);}/// <summary>Updates a pet in the store with form data</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceIUpdatePetWithFormEndpoint{/// <summary>Updates a pet in the store with form data</summary>/// <param name="petId">ID of pet that needs to be updated</param>/// <param name="name">Name of pet that needs to be updated</param>/// <param name="status">Status of pet that needs to be updated</param>/// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>405</term>/// <description>Invalid input</description>/// </item>/// </list>/// </exception>[Post("/pet/{petId}")]TaskExecute(longpetId,[Query]stringname,[Query]stringstatus);}/// <summary>Deletes a pet</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceIDeletePetEndpoint{/// <summary>Deletes a pet</summary>/// <param name="petId">Pet id to delete</param>/// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid pet value</description>/// </item>/// </list>/// </exception>[Delete("/pet/{petId}")]TaskExecute(longpetId,[Header("api_key")]stringapi_key);}/// <summary>uploads an image</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceIUploadFileEndpoint{/// <summary>uploads an image</summary>/// <param name="petId">ID of pet to update</param>/// <param name="additionalMetadata">Additional Metadata</param>/// <returns>/// A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>200</term>/// <description>successful operation</description>/// </item>/// </list>/// </returns>[Headers("Accept: application/json")][Post("/pet/{petId}/uploadImage")]Task<ApiResponse>Execute(longpetId,[Query]stringadditionalMetadata,StreamPartbody);}/// <summary>Returns pet inventories by status</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceIGetInventoryEndpoint{/// <summary>Returns pet inventories by status</summary>/// <remarks>Returns a map of status codes to quantities</remarks>/// <returns>successful operation</returns>/// <exception cref="ApiException">Thrown when the request returns a non-success status code.</exception>[Headers("Accept: application/json")][Get("/store/inventory")]Task<IDictionary<string,int>>Execute();}/// <summary>Place an order for a pet</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceIPlaceOrderEndpoint{/// <summary>Place an order for a pet</summary>/// <remarks>Place a new order in the store</remarks>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>405</term>/// <description>Invalid input</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/json")][Post("/store/order")]Task<Order>Execute([Body]Orderbody);}/// <summary>Find purchase order by ID</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceIGetOrderByIdEndpoint{/// <summary>Find purchase order by ID</summary>/// <remarks>For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions</remarks>/// <param name="orderId">ID of order that needs to be fetched</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid ID supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>Order not found</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/json")][Get("/store/order/{orderId}")]Task<Order>Execute(longorderId);}/// <summary>Delete purchase order by ID</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceIDeleteOrderEndpoint{/// <summary>Delete purchase order by ID</summary>/// <remarks>For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors</remarks>/// <param name="orderId">ID of the order that needs to be deleted</param>/// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid ID supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>Order not found</description>/// </item>/// </list>/// </exception>[Delete("/store/order/{orderId}")]TaskExecute(longorderId);}/// <summary>Create user</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceICreateUserEndpoint{/// <summary>Create user</summary>/// <remarks>This can only be done by the logged in user.</remarks>/// <param name="body">Created user object</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">Thrown when the request returns a non-success status code.</exception>[Headers("Accept: application/json, application/xml")][Post("/user")]TaskExecute([Body]Userbody);}/// <summary>Creates list of users with given input array</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceICreateUsersWithListInputEndpoint{/// <summary>Creates list of users with given input array</summary>/// <remarks>Creates list of users with given input array</remarks>/// <returns>Successful operation</returns>/// <exception cref="ApiException">Thrown when the request returns a non-success status code.</exception>[Headers("Accept: application/xml, application/json")][Post("/user/createWithList")]Task<User>Execute([Body]IEnumerable<User>body);}/// <summary>Logs user into the system</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceILoginUserEndpoint{/// <summary>Logs user into the system</summary>/// <param name="username">The user name for login</param>/// <param name="password">The password for login in clear text</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid username/password supplied</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/json")][Get("/user/login")]Task<string>Execute([Query]stringusername,[Query]stringpassword);}/// <summary>Logs out current logged in user session</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceILogoutUserEndpoint{/// <summary>Logs out current logged in user session</summary>/// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>/// <exception cref="ApiException">Thrown when the request returns a non-success status code.</exception>[Get("/user/logout")]TaskExecute();}/// <summary>Get user by user name</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceIGetUserByNameEndpoint{/// <summary>Get user by user name</summary>/// <param name="username">The name that needs to be fetched. Use user1 for testing.</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid username supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>User not found</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/json")][Get("/user/{username}")]Task<User>Execute(stringusername);}/// <summary>Update user</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceIUpdateUserEndpoint{/// <summary>Update user</summary>/// <remarks>This can only be done by the logged in user.</remarks>/// <param name="username">name that need to be deleted</param>/// <param name="body">Update an existent user in the store</param>/// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>/// <exception cref="ApiException">Thrown when the request returns a non-success status code.</exception>[Put("/user/{username}")]TaskExecute(stringusername,[Body]Userbody);}/// <summary>Delete user</summary>[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceIDeleteUserEndpoint{/// <summary>Delete user</summary>/// <remarks>This can only be done by the logged in user.</remarks>/// <param name="username">The name that needs to be deleted</param>/// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid username supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>User not found</description>/// </item>/// </list>/// </exception>[Delete("/user/{username}")]TaskExecute(stringusername);}

$ refitter ./openapi.json --namespace"Your.Namespace.Of.Choice.GeneratedCode" --use-dynamic-querystring-parameters

[System.CodeDom.Compiler.GeneratedCode("Refitter","1.0.0.0")]publicpartialinterfaceISwaggerPetstoreOpenAPI30{/// <summary>Update an existing pet</summary>/// <remarks>Update an existing pet by Id</remarks>/// <param name="body">Update an existent pet in the store</param>/// <returns>Successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid ID supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>Pet not found</description>/// </item>/// <item>/// <term>405</term>/// <description>Validation exception</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/xml, application/json")][Put("/pet")]Task<Pet>UpdatePet([Body]Petbody);/// <summary>Add a new pet to the store</summary>/// <remarks>Add a new pet to the store</remarks>/// <param name="body">Create a new pet in the store</param>/// <returns>Successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>405</term>/// <description>Invalid input</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/xml, application/json")][Post("/pet")]Task<Pet>AddPet([Body]Petbody);/// <summary>Finds Pets by status</summary>/// <remarks>Multiple status values can be provided with comma separated strings</remarks>/// <param name="status">Status values that need to be considered for filter</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid status value</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/xml, application/json")][Get("/pet/findByStatus")]Task<ICollection<Pet>>FindPetsByStatus([Query]Status?status);/// <summary>Finds Pets by tags</summary>/// <remarks>Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.</remarks>/// <param name="tags">Tags to filter by</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid tag value</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/xml, application/json")][Get("/pet/findByTags")]Task<ICollection<Pet>>FindPetsByTags([Query(CollectionFormat.Multi)]IEnumerable<string>tags);/// <summary>Find pet by ID</summary>/// <remarks>Returns a single pet</remarks>/// <param name="petId">ID of pet to return</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid ID supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>Pet not found</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/xml, application/json")][Get("/pet/{petId}")]Task<Pet>GetPetById(longpetId);/// <summary>Updates a pet in the store with form data</summary>/// <param name="petId">ID of pet that needs to be updated</param>/// <param name="queryParams">The dynamic querystring parameter wrapping all others.</param>/// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>405</term>/// <description>Invalid input</description>/// </item>/// </list>/// </exception>[Post("/pet/{petId}")]TaskUpdatePetWithForm(longpetId,[Query]UpdatePetWithFormQueryParamsqueryParams);/// <summary>Deletes a pet</summary>/// <param name="petId">Pet id to delete</param>/// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid pet value</description>/// </item>/// </list>/// </exception>[Delete("/pet/{petId}")]TaskDeletePet(longpetId,[Header("api_key")]stringapi_key);/// <summary>uploads an image</summary>/// <param name="petId">ID of pet to update</param>/// <param name="additionalMetadata">Additional Metadata</param>/// <returns>/// A <see cref="Task"/> representing the <see cref="IApiResponse"/> instance containing the result:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>200</term>/// <description>successful operation</description>/// </item>/// </list>/// </returns>[Headers("Accept: application/json")][Post("/pet/{petId}/uploadImage")]Task<ApiResponse>UploadFile(longpetId,[Query]stringadditionalMetadata,StreamPartbody);/// <summary>Returns pet inventories by status</summary>/// <remarks>Returns a map of status codes to quantities</remarks>/// <returns>successful operation</returns>/// <exception cref="ApiException">Thrown when the request returns a non-success status code.</exception>[Headers("Accept: application/json")][Get("/store/inventory")]Task<IDictionary<string,int>>GetInventory();/// <summary>Place an order for a pet</summary>/// <remarks>Place a new order in the store</remarks>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>405</term>/// <description>Invalid input</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/json")][Post("/store/order")]Task<Order>PlaceOrder([Body]Orderbody);/// <summary>Find purchase order by ID</summary>/// <remarks>For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.</remarks>/// <param name="orderId">ID of order that needs to be fetched</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid ID supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>Order not found</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/xml, application/json")][Get("/store/order/{orderId}")]Task<Order>GetOrderById(longorderId);/// <summary>Delete purchase order by ID</summary>/// <remarks>For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors</remarks>/// <param name="orderId">ID of the order that needs to be deleted</param>/// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid ID supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>Order not found</description>/// </item>/// </list>/// </exception>[Delete("/store/order/{orderId}")]TaskDeleteOrder(longorderId);/// <summary>Create user</summary>/// <remarks>This can only be done by the logged in user.</remarks>/// <param name="body">Created user object</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">Thrown when the request returns a non-success status code.</exception>[Headers("Accept: application/json, application/xml")][Post("/user")]TaskCreateUser([Body]Userbody);/// <summary>Creates list of users with given input array</summary>/// <remarks>Creates list of users with given input array</remarks>/// <returns>Successful operation</returns>/// <exception cref="ApiException">Thrown when the request returns a non-success status code.</exception>[Headers("Accept: application/xml, application/json")][Post("/user/createWithList")]Task<User>CreateUsersWithListInput([Body]IEnumerable<User>body);/// <summary>Logs user into the system</summary>/// <param name="queryParams">The dynamic querystring parameter wrapping all others.</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid username/password supplied</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/xml, application/json")][Get("/user/login")]Task<string>LoginUser([Query]LoginUserQueryParamsqueryParams);/// <summary>Logs out current logged in user session</summary>/// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>/// <exception cref="ApiException">Thrown when the request returns a non-success status code.</exception>[Get("/user/logout")]TaskLogoutUser();/// <summary>Get user by user name</summary>/// <param name="username">The name that needs to be fetched. Use user1 for testing.</param>/// <returns>successful operation</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid username supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>User not found</description>/// </item>/// </list>/// </exception>[Headers("Accept: application/xml, application/json")][Get("/user/{username}")]Task<User>GetUserByName(stringusername);/// <summary>Update user</summary>/// <remarks>This can only be done by the logged in user.</remarks>/// <param name="username">name that needs to be updated</param>/// <param name="body">Update an existent user in the store</param>/// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>/// <exception cref="ApiException">Thrown when the request returns a non-success status code.</exception>[Put("/user/{username}")]TaskUpdateUser(stringusername,[Body]Userbody);/// <summary>Delete user</summary>/// <remarks>This can only be done by the logged in user.</remarks>/// <param name="username">The name that needs to be deleted</param>/// <returns>A <see cref="Task"/> that completes when the request is finished.</returns>/// <exception cref="ApiException">/// Thrown when the request returns a non-success status code:/// <list type="table">/// <listheader>/// <term>Status</term>/// <description>Description</description>/// </listheader>/// <item>/// <term>400</term>/// <description>Invalid username supplied</description>/// </item>/// <item>/// <term>404</term>/// <description>User not found</description>/// </item>/// </list>/// </exception>[Delete("/user/{username}")]TaskDeleteUser(stringusername);}publicclassUpdatePetWithFormQueryParams{/// <summary>/// Name of pet that needs to be updated/// </summary>[Query]publicstringName{get;set;}/// <summary>/// Status of pet that needs to be updated/// </summary>[Query]publicstringStatus{get;set;}}publicclassLoginUserQueryParams{/// <summary>/// The user name for login/// </summary>[Query]publicstringUsername{get;set;}/// <summary>/// The password for login in clear text/// </summary>[Query]publicstringPassword{get;set;}}

RestService

usingRefit;usingSystem;usingSystem.Threading.Tasks;namespaceYour.Namespace.Of.Choice.GeneratedCode;internalclassProgram{privatestaticasyncTaskMain(string[]args){varclient=RestService.For<ISwaggerPetstore>("https://petstore3.swagger.io/api/v3");varpet=awaitclient.GetPetById(1);Console.WriteLine("## Using Task<T> as return type ##");Console.WriteLine($"Name:{pet.Name}");Console.WriteLine($"Category:{pet.Category.Name}");Console.WriteLine($"Status:{pet.Status}");Console.WriteLine();varclient2=RestService.For<WithApiResponse.ISwaggerPetstore>("https://petstore3.swagger.io/api/v3");varresponse=awaitclient2.GetPetById(2);Console.WriteLine("## Using Task<IApiResponse<T>> as return type ##");Console.WriteLine($"HTTP Status Code:{response.StatusCode}");Console.WriteLine($"Name:{response.Content.Name}");Console.WriteLine($"Category:{response.Content.Category.Name}");Console.WriteLine($"Status:{response.Content.Status}");}}

## Using Task<T> as return type ##Name: GatitotototoCategory: ChaucitoStatus: Sold## Using Task<IApiResponse<T>> as return type ##HTTP Status Code: OKName: GatitotototoCategory: ChaucitoStatus: Sold

ASP.NET Core and HttpClientFactory

usingRefit;usingYour.Namespace.Of.Choice.GeneratedCode;varbuilder=WebApplication.CreateBuilder(args);builder.Services.AddEndpointsApiExplorer();builder.Services.AddSwaggerGen();builder.Services.AddRefitClient<ISwaggerPetstore>().ConfigureHttpClient(c=>c.BaseAddress=newUri("https://petstore3.swagger.io/api/v3"));varapp=builder.Build();app.MapGet("/pet/{id:long}",async(ISwaggerPetstorepetstore,longid)=>{try{returnResults.Ok(awaitpetstore.GetPetById(id));}catch(Refit.ApiExceptione){returnResults.StatusCode((int)e.StatusCode);}}).WithName("GetPetById").WithOpenApi();app.UseHttpsRedirection();app.UseSwaggerUI();app.UseSwagger();app.Run();

$ curl -X'GET''https://localhost:5001/pet/1' -H'accept: application/json'

{"id":1,"name":"Special_char_owner_!@#$^&()`.testing","photoUrls": ["https://petstore3.swagger.io/resources/photos/623389095.jpg"  ],"tags": [],"status":"Sold"}

Dependency Injection

{"openApiPath":"../OpenAPI/v3.0/petstore.json","namespace":"Petstore","dependencyInjectionSettings": {"baseUrl":"https://petstore3.swagger.io/api/v3","httpMessageHandlers": ["TelemetryDelegatingHandler" ],"transientErrorHandler":"Polly","maxRetryCount":3,"firstBackoffRetryInSeconds":0.5  }}

publicstaticIServiceCollectionConfigureRefitClients(thisIServiceCollectionservices,Action<IHttpClientBuilder>?builder=default,RefitSettings?settings=default){varclientBuilderISwaggerPetstore=services.AddRefitClient<ISwaggerPetstore>(settings).ConfigureHttpClient(c=>c.BaseAddress=newUri("https://petstore3.swagger.io/api/v3")).AddHttpMessageHandler<TelemetryDelegatingHandler>();clientBuilderISwaggerPetstore.AddPolicyHandler(HttpPolicyExtensions.HandleTransientHttpError().WaitAndRetryAsync(Backoff.DecorrelatedJitterBackoffV2(TimeSpan.FromSeconds(0.5),3)));builder?.Invoke(clientBuilderISwaggerPetstore);returnservices;}

{"openApiPath":"../OpenAPI/v3.0/petstore.json","namespace":"Petstore","multipleInterfaces":"ByTag","dependencyInjectionSettings": {"baseUrl":"https://petstore3.swagger.io/api/v3","httpMessageHandlers": ["TelemetryDelegatingHandler" ],"transientErrorHandler":"Polly","maxRetryCount":3,"firstBackoffRetryInSeconds":0.5  }}

publicstaticIServiceCollectionConfigureRefitClients(thisIServiceCollectionservices,Action<IHttpClientBuilder>?builder=default,RefitSettings?settings=default){varclientBuilderIPetApi=services.AddRefitClient<IPetApi>(settings).ConfigureHttpClient(c=>c.BaseAddress=newUri("https://petstore3.swagger.io/api/v3")).AddHttpMessageHandler<TelemetryDelegatingHandler>();clientBuilderIPetApi.AddPolicyHandler(HttpPolicyExtensions.HandleTransientHttpError().WaitAndRetryAsync(Backoff.DecorrelatedJitterBackoffV2(TimeSpan.FromSeconds(0.5),3)));builder?.Invoke(clientBuilderIPetApi);varclientBuilderIStoreApi=services.AddRefitClient<IStoreApi>(settings).ConfigureHttpClient(c=>c.BaseAddress=newUri("https://petstore3.swagger.io/api/v3")).AddHttpMessageHandler<TelemetryDelegatingHandler>();clientBuilderIStoreApi.AddPolicyHandler(HttpPolicyExtensions.HandleTransientHttpError().WaitAndRetryAsync(Backoff.DecorrelatedJitterBackoffV2(TimeSpan.FromSeconds(0.5),3)));builder?.Invoke(clientBuilderIStoreApi);varclientBuilderIUserApi=services.AddRefitClient<IUserApi>(settings).ConfigureHttpClient(c=>c.BaseAddress=newUri("https://petstore3.swagger.io/api/v3")).AddHttpMessageHandler<TelemetryDelegatingHandler>();clientBuilderIUserApi.AddPolicyHandler(HttpPolicyExtensions.HandleTransientHttpError().WaitAndRetryAsync(Backoff.DecorrelatedJitterBackoffV2(TimeSpan.FromSeconds(0.5),3)));builder?.Invoke(clientBuilderIUserApi);returnservices;}

Apizr

Generating the interfaces

Generating the helpers

Extended

{"openApiPath":"../OpenAPI/v3.0/petstore.json","namespace":"Petstore","useDynamicQuerystringParameters":true,"dependencyInjectionSettings": {"baseUrl":"https://petstore3.swagger.io/api/v3","httpMessageHandlers": ["MyDelegatingHandler" ],"transientErrorHandler":"HttpResilience","maxRetryCount":3,"firstBackoffRetryInSeconds":0.5  },"apizrSettings": {"withRequestOptions":true,// Recommended to include an Apizr request options parameter to Refit interface methods"withRegistrationHelper":true,// Mandatory to actually generate the Apizr registration extended method"withCacheProvider":"InMemory",// Optional, default is None"withPriority":true,// Optional, default is false"withMediation":true,// Optional, default is false"withOptionalMediation":true,// Optional, default is false"withMappingProvider":"AutoMapper",// Optional, default is None"withFileTransfer":true// Optional, default is false  }}

publicstaticIServiceCollectionConfigurePetstoreApiApizrManager(thisIServiceCollectionservices,Action<IApizrExtendedManagerOptionsBuilder>?optionsBuilder=null){optionsBuilder??= _=>{};// Default empty options if nulloptionsBuilder+= options=>options.WithBaseAddress("https://petstore3.swagger.io/api/v3",ApizrDuplicateStrategy.Ignore).WithDelegatingHandler<MyDelegatingHandler>().ConfigureHttpClientBuilder(builder=>builder.AddStandardResilienceHandler(config=>{config.Retry=newHttpRetryStrategyOptions{UseJitter=true,MaxRetryAttempts=3,Delay=TimeSpan.FromSeconds(0.5)};})).WithInMemoryCacheHandler().WithAutoMapperMappingHandler().WithPriority().WithOptionalMediation().WithFileTransferOptionalMediation();returnservices.AddApizrManagerFor<IPetstoreApi>(optionsBuilder);}

{"openApiPath":"../OpenAPI/v3.0/petstore.json","namespace":"Petstore","useDynamicQuerystringParameters":true,"multipleInterfaces":"ByTag","naming": {"useOpenApiTitle":false,"interfaceName":"Petstore"  },"dependencyInjectionSettings": {"baseUrl":"https://petstore3.swagger.io/api/v3","httpMessageHandlers": ["MyDelegatingHandler" ],"transientErrorHandler":"HttpResilience","maxRetryCount":3,"firstBackoffRetryInSeconds":0.5  },"apizrSettings": {"withRequestOptions":true,// Recommended to include an Apizr request options parameter to Refit interface methods"withRegistrationHelper":true,// Mandatory to actually generate the Apizr registration extended method"withCacheProvider":"InMemory",// Optional, default is None"withPriority":true,// Optional, default is false"withMediation":true,// Optional, default is false"withOptionalMediation":true,// Optional, default is false"withMappingProvider":"AutoMapper",// Optional, default is None"withFileTransfer":true// Optional, default is false  }}

publicstaticIServiceCollectionConfigurePetstoreApizrManagers(thisIServiceCollectionservices,Action<IApizrExtendedCommonOptionsBuilder>?optionsBuilder=null){optionsBuilder??= _=>{};// Default empty options if nulloptionsBuilder+= options=>options.WithBaseAddress("https://petstore3.swagger.io/api/v3",ApizrDuplicateStrategy.Ignore).WithDelegatingHandler<MyDelegatingHandler>().ConfigureHttpClientBuilder(builder=>builder.AddStandardResilienceHandler(config=>{config.Retry=newHttpRetryStrategyOptions{UseJitter=true,MaxRetryAttempts=3,Delay=TimeSpan.FromSeconds(0.5)};})).WithInMemoryCacheHandler().WithAutoMapperMappingHandler().WithPriority().WithOptionalMediation().WithFileTransferOptionalMediation();returnservices.AddApizr(        registry=>registry.AddManagerFor<IPetApi>().AddManagerFor<IStoreApi>().AddManagerFor<IUserApi>(),optionsBuilder);}

Static

{"openApiPath":"../OpenAPI/v3.0/petstore.json","namespace":"Petstore","useDynamicQuerystringParameters":true,"apizrSettings": {"withRequestOptions":true,// Recommended to include an Apizr request options parameter to Refit interface methods"withRegistrationHelper":true,// Mandatory to actually generate the Apizr registration extended method"withCacheProvider":"Akavache",// Optional, default is None"withPriority":true,// Optional, default is false"withMappingProvider":"AutoMapper",// Optional, default is None"withFileTransfer":true// Optional, default is false  }}

publicstaticIApizrManager<ISwaggerPetstoreOpenAPI30>BuildPetstore30ApizrManager(Action<IApizrManagerOptionsBuilder>optionsBuilder){optionsBuilder??= _=>{};// Default empty options if nulloptionsBuilder+= options=>options.WithAkavacheCacheHandler().WithAutoMapperMappingHandler(newMapperConfiguration(config=>{/* YOUR_MAPPINGS_HERE */})).WithPriority();returnApizrBuilder.Current.CreateManagerFor<ISwaggerPetstoreOpenAPI30>(optionsBuilder);}

{"openApiPath":"../OpenAPI/v3.0/petstore.json","namespace":"Petstore","useDynamicQuerystringParameters":true,"multipleInterfaces":"ByTag","naming": {"useOpenApiTitle":false,"interfaceName":"Petstore"  },"dependencyInjectionSettings": {"baseUrl":"https://petstore3.swagger.io/api/v3","httpMessageHandlers": ["MyDelegatingHandler" ],"transientErrorHandler":"HttpResilience","maxRetryCount":3,"firstBackoffRetryInSeconds":0.5  },"apizrSettings": {"withRequestOptions":true,// Recommended to include an Apizr request options parameter to Refit interface methods"withRegistrationHelper":true,// Mandatory to actually generate the Apizr registration extended method"withCacheProvider":"InMemory",// Optional, default is None"withPriority":true,// Optional, default is false"withMediation":true,// Optional, default is false"withOptionalMediation":true,// Optional, default is false"withMappingProvider":"AutoMapper",// Optional, default is None"withFileTransfer":true// Optional, default is false  }}

publicstaticIApizrRegistryBuildPetstoreApizrManagers(Action<IApizrCommonOptionsBuilder>optionsBuilder){optionsBuilder??= _=>{};// Default empty options if nulloptionsBuilder+= options=>options.WithAkavacheCacheHandler().WithAutoMapperMappingHandler(newMapperConfiguration(config=>{/* YOUR_MAPPINGS_HERE */})).WithPriority();returnApizrBuilder.Current.CreateRegistry(        registry=>registry.AddManagerFor<IPetApi>().AddManagerFor<IStoreApi>().AddManagerFor<IUserApi>(),optionsBuilder);}

Customizing the configuration

Using the managers

varresult=awaitpetstoreManager.ExecuteAsync((api,opt)=>api.GetPetById(1,opt),     options=>options// Whatever final request options you want to apply.WithPriority(Priority.Background).WithHeaders(["HeaderKey1: HeaderValue1"]).WithRequestTimeout("00:00:10").WithCancellation(cts.Token));

System requirements

Contributors