NSwag генерирует единый клиентский класс

#swagger #code-generation #swashbuckle #nswag #nswagstudio

#swagger #генерация кода #swashbuckle #nswag #nswagstudio

Вопрос:

При использовании NSwagStudio для генерации клиентского кода C # (не в файле) он генерирует способ, которым генерируется только один клиентский класс и соответствующий интерфейс со всеми методами контроллеров в них. Однако при попытке сделать то же самое с NSwag.MSBuild ним генерируются отдельные частичные классы / интерфейсы для каждого контроллера.

Вот nswag.json :

 {
"openApiToCSharpClient": {
  "clientBaseClass": "BillingBaseClient",
  "configurationClass": "ConnectionOptions",
  "generateClientClasses": true,
  "generateClientInterfaces": true,
  "clientBaseInterface": null,
  "injectHttpClient": true,
  "disposeHttpClient": true,
  "protectedMethods": [
  ],
  "generateExceptionClasses": true,
  "exceptionClass": "ApiException",
  "wrapDtoExceptions": true,
  "useHttpClientCreationMethod": false,
  "httpClientType": "System.Net.Http.HttpClient",
  "useHttpRequestMessageCreationMethod": true,
  "useBaseUrl": true,
  "generateBaseUrlProperty": false,
  "generateSyncMethods": false,
  "exposeJsonSerializerSettings": false,
  "clientClassAccessModifier": "public",
  "typeAccessModifier": "public",
  "generateContractsOutput": false,
  "contractsNamespace": null,
  "contractsOutputFilePath": null,
  "parameterDateTimeFormat": "s",
  "parameterDateFormat": "yyyy-MM-dd",
  "generateUpdateJsonSerializerSettingsMethod": true,
  "useRequestAndResponseSerializationSettings": false,
  "serializeTypeInformation": false,
  "queryNullValue": "",
  "className": "BillingClient",
  "operationGenerationMode": "MultipleClientsFromOperationId",
  "additionalNamespaceUsages": [
  ],
  "additionalContractNamespaceUsages": [
  ],
  "generateOptionalParameters": true,
  "generateJsonMethods": true,
  "enforceFlagEnums": false,
  "parameterArrayType": "System.Collections.Generic.IEnumerable",
  "parameterDictionaryType": "System.Collections.Generic.IDictionary",
  "responseArrayType": "System.Collections.Generic.ICollection",
  "responseDictionaryType": "System.Collections.Generic.IDictionary",
  "wrapResponses": false,
  "wrapResponseMethods": [
  ],
  "generateResponseClasses": true,
  "responseClass": "SwaggerResponse",
  "namespace": "ServiceTitan.Billing.Api.Client",
  "requiredPropertiesMustBeDefined": true,
  "dateType": "System.DateTimeOffset",
  "jsonConverters": null,
  "anyType": "object",
  "dateTimeType": "System.DateTimeOffset",
  "timeType": "System.TimeSpan",
  "timeSpanType": "System.TimeSpan",
  "arrayType": "System.Collections.Generic.ICollection",
  "arrayInstanceType": "System.Collections.ObjectModel.Collection",
  "dictionaryType": "System.Collections.Generic.IDictionary",
  "dictionaryInstanceType": "System.Collections.Generic.Dictionary",
  "arrayBaseType": "System.Collections.ObjectModel.Collection",
  "dictionaryBaseType": "System.Collections.Generic.Dictionary",
  "classStyle": "Poco",
  "generateDefaultValues": true,
  "generateDataAnnotations": true,
  "excludedTypeNames": [
  ],
  "excludedParameterNames": [
  ],
  "handleReferences": false,
  "generateImmutableArrayProperties": false,
  "generateImmutableDictionaryProperties": false,
  "jsonSerializerSettingsTransformationMethod": null,
  "inlineNamedArrays": false,
  "inlineNamedDictionaries": false,
  "inlineNamedTuples": true,
  "inlineNamedAny": false,
  "generateDtoTypes": true,
  "generateOptionalPropertiesAsNullable": false,
  "templateDirectory": null,
  "typeNameGeneratorType": null,
  "propertyNameGeneratorType": null,
  "enumNameGeneratorType": null,
  "serviceHost": null,
  "serviceSchemes": null,
  "output": "BillingClient.g.cs"
  }
}
  

Итак, какой вариант мне не хватает для указания NSwag генерировать один класс / интерфейс?

Ответ №1:

Параметр operationGenerationMode , который вам нужно изменить, уже есть в вашем файле nswag.json, но вам нужно изменить его значение на SingleClientFromOperationId , если вы хотите иметь один интерфейс для нескольких контроллеров. MultipleClientsFromOperationId то, что вы установили в данный момент, будет генерировать класс для каждого контроллера.