diff --git a/Server/Controller/SwaggerController.cs b/Server/Controller/SwaggerController.cs index d2289c0..a1c44b9 100644 --- a/Server/Controller/SwaggerController.cs +++ b/Server/Controller/SwaggerController.cs @@ -1,4 +1,5 @@ using Microsoft.AspNetCore.Mvc; +using Microsoft.OpenApi.Models; using Swashbuckle.AspNetCore.SwaggerGen; using System.Text; @@ -18,7 +19,9 @@ public class SwaggerController : ControllerBase /// [Route("get/{version}")] + [Produces("text/html")] [HttpGet] + [ResponseCache(NoStore = true, Location = ResponseCacheLocation.None)] public ActionResult GetApi(string version) { var model = generator.GetSwagger(version); @@ -29,106 +32,245 @@ public class SwaggerController : ControllerBase Flower Story - API 接口文档

{model.Info.Title}

接口文档 {model.Info.Version}

-

{model.Info.Description}

"); - foreach (var item in model.Paths) +
+

{model.Info.Description}

+
"); + foreach (var tag in model.Tags) { - if (item.Value.Operations != null) + if (tag == null) { - foreach (var operation in item.Value.Operations) + continue; + } + builder.Append($@" +

{tag.Description}

+
"); + foreach (var item in model.Paths) + { + if (item.Value.Operations != null) { - if (string.IsNullOrEmpty(operation.Value.Summary)) + foreach (var operation in item.Value.Operations) { - continue; - } - builder.Append($@" -

{operation.Value.Summary}

- - - - - - - - - - "); - if (operation.Value.Parameters?.Count > 0) - { - builder.Append(@" - - - - - - "); - foreach (var param in operation.Value.Parameters) + if (!operation.Value.Tags.Any(t => t.Name == tag.Name)) { - builder.Append($@" - - - - - - "); + continue; + } + var method = operation.Key.ToString(); + builder.Append($@" +

{operation.Value.Summary}

+ 
{method.ToUpper()} {item.Key}
"); + if (operation.Value.Parameters?.Count > 0) + { + builder.Append(@" +

请求参数

+
URL{item.Key}
请求方式{operation.Key}
参数参数类型是否必须说明
{param.Name}{param.In}{param.Required}{param.Description}
+ "); + foreach (var param in operation.Value.Parameters) + { + var required = param.Required ? "*" : string.Empty; + builder.Append($@" + + + + + + "); + } + builder.Append(@" +
参数位置类型说明
{required}{param.Name}{param.In}{param.Schema.Type}{param.Description}
"); + } + if (operation.Value.RequestBody?.Content != null) + { + foreach (var content in operation.Value.RequestBody.Content) + { + builder.Append($@" +

请求实体 ({content.Key})

+ + "); + if (content.Value.Schema.Type == "array") + { + builder.Append($@" + + + + + "); + } + else + { + IDictionary properties; + if (content.Value.Schema.Reference != null && model.Components.Schemas.TryGetValue(content.Value.Schema.Reference.Id, out var schema)) + { + properties = schema.Properties; + } + else + { + properties = content.Value.Schema.Properties; + } + foreach (var prop in properties) + { + var required = content.Value.Schema.Required.Contains(prop.Key) ? "*" : string.Empty; + var type = prop.Value.Type; + if (type == "string" && prop.Value.Format == "binary") + { + type = "file"; + } + else if (type == "array") + { + type = prop.Value.Items.Type; + if (type == "string" && prop.Value.Items.Format == "binary") + { + type = "file"; + } + type += "[]"; + } + builder.Append($@" + + + + + "); + } + } + builder.Append(@" +
字段类型说明
.{content.Value.Schema.Items.Type}[]{operation.Value.RequestBody.Description}
{required}{prop.Key}{type}{prop.Value.Description}
"); + } + } + if (operation.Value.Responses?.Count > 0) + { + builder.Append(@" +

响应 HTTP 状态

+ + "); + foreach (var response in operation.Value.Responses) + { + builder.Append($@" + + + + "); + if (response.Key == "200") + { + foreach (var content in response.Value.Content) + { + builder.Append($@" + + + "); + } + } + } + builder.Append(@" +
状态码说明
{response.Key}{response.Value.Description}
+

{content.Key}

+ + "); + OpenApiSchema schema; + if (content.Value.Schema.Type == "array") + { + schema = content.Value.Schema.Items; + builder.Append($@" + "); + } + else + { + schema = content.Value.Schema; + } + if (schema.Reference != null && model.Components.Schemas.TryGetValue(schema.Reference.Id, out var s)) + { + schema = s; + } + if (schema.Properties.Count > 0) + { + foreach (var p in schema.Properties) + { + bool isArray = p.Value.Type == "array"; + string type = isArray ? $"{p.Value.Items.Reference?.Id ?? p.Value.Items.Type}[]" : p.Value.Type; + builder.Append($@" + + + + + "); + if (isArray && p.Value.Items.Reference != null && model.Components.Schemas.TryGetValue(p.Value.Items.Reference.Id, out s)) + { + foreach (var p2 in s.Properties) + { + builder.Append($@" + + + + + "); + } + } + } + } + else + { + builder.Append($@" + + + + + "); + } + builder.Append(@" +
字段类型说明
.{schema.Reference?.Id ?? schema.Type}[]
{p.Key}{type}{p.Value.Description}
  {p2.Key}{p2.Value.Type}{p2.Value.Description}
.{schema.Type}
+
"); } } - if (operation.Value.Responses?.Count > 0) - { - builder.Append(@" - - 状态码 - 说明 - "); - foreach (var response in operation.Value.Responses) - { - builder.Append($@" - - {response.Key} - {response.Value.Description} - "); - } - } - builder.Append(@" - "); } } + builder.Append(@" +
"); } builder.Append(@"