framework/Zongsoft.Web/openapi/DocumentGenerator.cs at main · Zongsoft/framework · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
/*
 *   _____                                ______
 *  /_   /  ____  ____  ____  _________  / __/ /_
 *    / /  / __ \/ __ \/ __ \/ ___/ __ \/ /_/ __/
 *   / /__/ /_/ / / / / /_/ /\_ \/ /_/ / __/ /_
 *  /____/\____/_/ /_/\__  /____/\____/_/  \__/
 *                   /____/
 *
 * Authors:
 *   钟峰(Popeye Zhong) <zongsoft@qq.com>
 *
 * Copyright (C) 2020-2025 Zongsoft Studio <http://www.zongsoft.com>
 *
 * This file is part of Zongsoft.Web.OpenApi library.
 *
 * The Zongsoft.Web.OpenApi is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3.0 of the License,
 * or (at your option) any later version.
 *
 * The Zongsoft.Web.OpenApi is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with the Zongsoft.Web.OpenApi library. If not, see <http://www.gnu.org/licenses/>.
 */

using System;
using System.Collections.Generic;

using Microsoft.OpenApi;

using Zongsoft.Services;

namespace Zongsoft.Web.OpenApi;

public static partial class DocumentGenerator
{
	public static OpenApiDocument Generate(DocumentContext context) => Generate(context, ApplicationContext.Current?.Properties.GetValue<ControllerServiceDescriptorCollection>());
	public static OpenApiDocument Generate(DocumentContext context, ControllerServiceDescriptorCollection descriptors)
	{
		if(descriptors == null)
			return null;

		//确保文档对象已创建
		context.Document ??= CreateDocument();

		//添加环境名到扩展集
		context.Document.AddExtension("x-environment", Extensions.Helper.String(ApplicationContext.Current.Environment.Name));
		context.Document.AddExtension("x-scalar-active-environment", Extensions.Helper.String(ApplicationContext.Current.Environment.Name));

		//生成环境列表
		context.GenerateEnvironments();

		//生成服务器列表
		context.GenerateServers();

		//生成安全方案列表
		context.GenerateSecuritySchemes();

		//生成API路径列表
		context.GeneratePaths(descriptors);

		return context.Document;

		static OpenApiDocument CreateDocument() => new()
		{
			Info = new()
			{
				Title = ApplicationContext.Current.Title,
				Description = ApplicationContext.Current.Description,
				Version = ApplicationContext.Current.Version.ToString(),
			},
			Tags = new HashSet<OpenApiTag>(),
			Components = new()
			{
				Schemas = new Dictionary<string, IOpenApiSchema>(),
				Responses = new Dictionary<string, IOpenApiResponse>(),
				RequestBodies = new Dictionary<string, IOpenApiRequestBody>(),
			},
		};
	}
}