У меня довольно сложный объект с вложенными объектами;обратите внимание, что в приведенном ниже примере я значительно упростил этот объект.
Предположим, что следующий пример объекта:
public class Result {
public string Name { get; set; }
public IpAddress IpAddress { get; set; }
}
Я реализовал JsonConverter<IPAddress>, чем (де) сериализует Ip какстрока:
public class IPAddressConverter : JsonConverter<IPAddress>
{
public override IPAddress Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
=> IPAddress.Parse(reader.GetString());
public override void Write(Utf8JsonWriter writer, IPAddress value, JsonSerializerOptions options)
=> writer.WriteStringValue(value.ToString());
}
Затем IPAddressConverter был «зарегистрирован» как преобразователь в методе AddJsonOptions(...). Это приятно возвращает результаты в виде:
{ "Name": "Foo", "IpAddress": "198.51.100.1" }
И, наоборот, мой контроллер «понимает» IP-адреса, указанные в виде строки:
public IEnumerable<Result> FindByIp(IpAddress ip) {
// ...
}
Однако SwashBuckle экспортирует это как:
{
"openapi": "3.0.1",
"info": {
"title": "Example",
"version": "v1"
},
"paths": {
"/FindByIp": {
"get": {
"parameters": [
{
"name": "q",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Result"
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AddressFamily": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
6,
7,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
21,
22,
23,
24,
25,
26,
28,
29,
65536,
65537,
-1
],
"type": "integer",
"format": "int32"
},
"IPAddress": {
"type": "object",
"properties": {
"addressFamily": {
"$ref": "#/components/schemas/AddressFamily"
},
"scopeId": {
"type": "integer",
"format": "int64"
},
"isIPv6Multicast": {
"type": "boolean",
"readOnly": true
},
"isIPv6LinkLocal": {
"type": "boolean",
"readOnly": true
},
"isIPv6SiteLocal": {
"type": "boolean",
"readOnly": true
},
"isIPv6Teredo": {
"type": "boolean",
"readOnly": true
},
"isIPv4MappedToIPv6": {
"type": "boolean",
"readOnly": true
},
"address": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"Result": {
"type": "object",
"properties": {
"ip": {
"$ref": "#/components/schemas/IPAddress"
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
}
}
}
Что для более зрительных склонностей выглядит следующим образом:
Однако я бы хотел добиться этого:
{
"openapi": "3.0.1",
"info": {
"title": "Example",
"version": "v1"
},
"paths": {
"/FindByIp": {
"get": {
"parameters": [
{
"name": "q",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Result"
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Result": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
}
}
}
Опять визуализировано:
Я надеялся добавить аннотацию / атрибут к некоторым свойствам(поэтому я посмотрел на Swashbuckle.AspNetCore.Annotations ), но это кажется невозможным.
Кроме того, поскольку объект довольно сложный и поступает из сторонней библиотеки, это сложнодля меня, чтобы фактически добавить аннотации / атрибуты к свойствам, потому что я не могу изменить модель (легко).
I может прибегнуть к AutoMapper (или подобному), чтобы создать другую модель со строкойдля IP-адресов, но это означало бы необходимость моделировать все объекты в исходной модели. Кроме того, он требует дополнительного кода и обслуживания при изменении модели. Я бы скорее сказал Swashbuckle, что IP-адреса (и, таким образом, тип IPAddress будет представлен в виде строки (входящей и исходящей для моего API). Я ищу вариантыо том, как добиться этого наилучшим способом в данных ограничениях (желательно не вводить новые модели для сопоставления, предпочтительно без аннотаций / атрибутов, потому что я не могу легко получить доступ к сторонней библиотеке). Есть ли способ зарегистрироватьконвертер-что-то "для Swashbuckle, чтобы справиться с этим?
Обновление: Решено !
Это то, что я закончил с:
// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
services
.AddResponseCompression()
.AddMemoryCache()
.AddControllers()
// etc...
// etc...
// Here's the interesting part:
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "Example", Version = "v1" });
c.MapType<IPAddress>(() => new OpenApiSchema { Type = typeof(string).Name });
// ...
});
}
СпасибоВы strickt01