weiai/TouchSocket
1
0
Fork 0
mirror of https://github.com/RRQM/TouchSocket.git synced 2025-12-17 17:06:45 +08:00
Code Issues Packages Projects Releases Wiki Activity

swagger添加对象属性描述

Browse Source
This commit is contained in:
xwltz
2025-04-17 17:43:15 +08:00
parent 26efbbc247
commit fca1668c8c
2 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/TouchSocket.WebApi.Swagger/Common/OpenApiProperty.cs
View File

@@ -30,4 +30,7 @@ internal class OpenApiProperty
[JsonProperty("items")]
public OpenApiProperty Items { get; set; }
[JsonProperty("description")]
public string Description { get; set; }
}

11
src/TouchSocket.WebApi.Swagger/Plugins/SwaggerPlugin.cs
View File

@@ -14,6 +14,7 @@ using Newtonsoft.Json;
using System;
using System.Collections;
using System.Collections.Generic;
using System.ComponentModel;
using System.Diagnostics;
using System.IO;
using System.Linq;
@@ -350,11 +351,10 @@ public sealed class SwaggerPlugin : PluginBase, IServerStartedPlugin, IHttpPlugi
openApiPathValue.Responses.Add("200", openApiResponse);
}
private OpenApiProperty CreateProperty(Type type)
private OpenApiProperty CreateProperty(Type type, string description = "")
{
var openApiProperty = new OpenApiProperty();
var dataTypes = this.ParseDataTypes(type);
switch (dataTypes)
{
case OpenApiDataTypes.String:
@@ -380,7 +380,7 @@ public sealed class SwaggerPlugin : PluginBase, IServerStartedPlugin, IHttpPlugi
case OpenApiDataTypes.Array:
{
openApiProperty.Type = dataTypes;
openApiProperty.Items = this.CreateProperty(type.IsArray ? type.GetElementType() : type.GetGenericArguments()[0]);
openApiProperty.Items = this.CreateProperty(type.IsArray ? type.GetElementType() : type.GetGenericArguments()[0], description);
}
break;
@@ -400,7 +400,7 @@ public sealed class SwaggerPlugin : PluginBase, IServerStartedPlugin, IHttpPlugi
}
openApiProperty.Format = this.GetSchemaFormat(type);
openApiProperty.Description = description;
return openApiProperty;
}
@@ -486,7 +486,8 @@ public sealed class SwaggerPlugin : PluginBase, IServerStartedPlugin, IHttpPlugi
var properties = new Dictionary<string, OpenApiProperty>();
foreach (var propertyInfo in type.GetProperties(BindingFlags.Instance | BindingFlags.Public))
{
properties.Add(propertyInfo.Name, this.CreateProperty(propertyInfo.PropertyType));
var description = propertyInfo.GetCustomAttribute<DescriptionAttribute>()?.Description;
properties.Add(propertyInfo.Name, this.CreateProperty(propertyInfo.PropertyType, description));
}
schema.Properties = properties.Count == 0 ? default : properties;
components.Schemas.TryAdd(this.GetSchemaName(type), schema);