API/Common/OpenAPI/DocumentDefaults.cs at 1cc83eb07dfa015bb821fc532a8032790dd48be8 · OpenShock/API · 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
using Microsoft.AspNetCore.OpenApi;
using Microsoft.OpenApi;

namespace OpenShock.Common.OpenAPI;

public static class DocumentDefaults
{
    public static Func<OpenApiDocument, OpenApiDocumentTransformerContext, CancellationToken, Task> GetDocumentTransformer(string version)
    {
        return (document, context, _) =>
        {
            var env = context.ApplicationServices.GetRequiredService<IHostEnvironment>();

            document.Info = new OpenApiInfo
            {
                Title = "OpenShock.API",
                // Summary = ...
                // Description = ...
                Version = version,
                // TermsOfService = ...
                // Contact = ...
                // License = ...
            };

            document.Servers =
            [
                new OpenApiServer { Url = "https://api.openshock.app" },
                new OpenApiServer { Url = "https://api.openshock.dev" }
            ];
            if (env.IsDevelopment())
            {
                document.Servers.Add(new OpenApiServer { Url = "https://localhost" });
            }

            document.Components ??= new OpenApiComponents();
            document.Components.SecuritySchemes = new Dictionary<string, IOpenApiSecurityScheme>
            {
                {
                    "ApiToken",
                    new OpenApiSecurityScheme
                    {
                        Name = "OpenShockToken",
                        Description = "Enter API Token",
                        Type = SecuritySchemeType.ApiKey,
                        In = ParameterLocation.Header
                    }
                },
                {
                    "HubToken",
                    new OpenApiSecurityScheme
                    {
                        Name = "DeviceToken",
                        Description = "Enter hub token",
                        Type = SecuritySchemeType.ApiKey,
                        In = ParameterLocation.Header
                    }
                },
                {
                    "UserSessionCookie",
                    new OpenApiSecurityScheme
                    {
                        Name = "openShockSession",
                        Description = "Enter user session cookie",
                        Type = SecuritySchemeType.ApiKey,
                        In = ParameterLocation.Cookie
                    }
                }
            };

            return Task.CompletedTask;
        };
    }
}