| | | 1 | | using System.Reflection; |
| | | 2 | | using Scalar.AspNetCore; |
| | | 3 | | using Microsoft.OpenApi.Any; |
| | | 4 | | using Syki.Back.Auth.Schemes; |
| | | 5 | | using Microsoft.OpenApi.Models; |
| | | 6 | | using Microsoft.OpenApi.Interfaces; |
| | | 7 | | |
| | | 8 | | namespace Syki.Back.Configs; |
| | | 9 | | |
| | | 10 | | public static class DocsConfigs |
| | | 11 | | { |
| | | 12 | | public static void AddDocsConfigs(this WebApplicationBuilder builder) |
| | | 13 | | { |
| | 2 | 14 | | builder.Services.AddSwaggerGen(options => |
| | 2 | 15 | | { |
| | 2 | 16 | | options.SwaggerDoc("v1", new OpenApiInfo |
| | 2 | 17 | | { |
| | 2 | 18 | | Title = "Syki API Docs", |
| | 2 | 19 | | Description = ReadResource("api-intro.md"), |
| | 2 | 20 | | Extensions = new Dictionary<string, IOpenApiExtension> |
| | 2 | 21 | | { |
| | 2 | 22 | | { "x-logo", new OpenApiObject |
| | 2 | 23 | | { |
| | 2 | 24 | | { "url", new OpenApiString("/syki-logo.png") }, |
| | 2 | 25 | | }} |
| | 2 | 26 | | }, |
| | 2 | 27 | | }); |
| | 2 | 28 | | |
| | 2 | 29 | | options.EnableAnnotations(); |
| | 2 | 30 | | |
| | 2 | 31 | | options.TagActionsBy(api => |
| | 2 | 32 | | { |
| | 0 | 33 | | var group = api.RelativePath.Split("/")[0]; |
| | 0 | 34 | | if (group == "campi") return ["🏫 Campi"]; |
| | 0 | 35 | | if (group == "courses") return ["📚 Courses"]; |
| | 0 | 36 | | if (group == "course-curriculums") return ["📋 Curriculums"]; |
| | 0 | 37 | | if (group == "course-offerings") return ["🗓️ Offerings"]; |
| | 0 | 38 | | if (group == "disciplines") return ["📖 Disciplines"]; |
| | 0 | 39 | | if (group == "periods") return ["📅 Periods"]; |
| | 0 | 40 | | if (group == "students") return ["🎓 Students"]; |
| | 0 | 41 | | if (group == "teachers") return ["👨🏫 Teachers"]; |
| | 0 | 42 | | if (group == "identity") return ["🛡️ Identity"]; |
| | 0 | 43 | | if (group == "users") return ["👩🏻🎓 Users"]; |
| | 0 | 44 | | if (group == "webhooks") return ["🪝 Webhooks"]; |
| | 0 | 45 | | if (group == "classes") return ["👩🏻🏫 Classes"]; |
| | 0 | 46 | | if (group == "notifications") return ["🔔 Notifications"]; |
| | 0 | 47 | | return ["🧱 Cross"]; |
| | 2 | 48 | | }); |
| | 2 | 49 | | options.DocInclusionPredicate((name, api) => true); |
| | 2 | 50 | | |
| | 2 | 51 | | options.SchemaFilter<EnumSchemaFilter>(); |
| | 2 | 52 | | options.OperationFilter<AuthOperationsFilter>(); |
| | 2 | 53 | | options.OperationFilter<IdParameterExamplesFilter>(); |
| | 2 | 54 | | options.OperationFilter<ExamplesOperationsFilterFilter>(); |
| | 2 | 55 | | options.DocumentFilter<HttpMethodSorterDocumentFilter>(); |
| | 2 | 56 | | |
| | 2 | 57 | | options.ExampleFilters(); |
| | 2 | 58 | | |
| | 2 | 59 | | options.AddSecurityDefinition( |
| | 2 | 60 | | JwtBearerScheme.Name, |
| | 2 | 61 | | new OpenApiSecurityScheme |
| | 2 | 62 | | { |
| | 2 | 63 | | In = ParameterLocation.Cookie, |
| | 2 | 64 | | Name = JwtBearerScheme.Cookie, |
| | 2 | 65 | | Type = SecuritySchemeType.ApiKey, |
| | 2 | 66 | | Description = "JWT enviado no cookie http only", |
| | 2 | 67 | | }); |
| | 2 | 68 | | |
| | 2 | 69 | | options.DescribeAllParametersInCamelCase(); |
| | 2 | 70 | | |
| | 2 | 71 | | var xmlPath = Path.Combine(AppContext.BaseDirectory, "Back.xml"); |
| | 2 | 72 | | options.IncludeXmlComments(xmlPath, includeControllerXmlComments: true); |
| | 4 | 73 | | }); |
| | | 74 | | |
| | 2 | 75 | | builder.Services.AddSwaggerExamplesFromAssemblyOf(typeof(Program)); |
| | 2 | 76 | | builder.Services.AddOpenApi(); |
| | 2 | 77 | | } |
| | | 78 | | |
| | | 79 | | public static void MapScalarDocs(this IEndpointRouteBuilder options) |
| | | 80 | | { |
| | 2 | 81 | | options.MapScalarApiReference("/docs", options => |
| | 2 | 82 | | { |
| | 2 | 83 | | options.WithModels(false); |
| | 2 | 84 | | options.WithTitle("Syki API Docs"); |
| | 2 | 85 | | options.WithDocumentDownloadType(DocumentDownloadType.Json); |
| | 2 | 86 | | options.WithOpenApiRoutePattern("/swagger/{documentName}/swagger.json"); |
| | 2 | 87 | | options |
| | 2 | 88 | | .AddPreferredSecuritySchemes("Bearer") |
| | 4 | 89 | | .AddHttpAuthentication("Bearer", x => x.Token = "your.bearer.token"); |
| | 2 | 90 | | |
| | 2 | 91 | | options.CustomCss = @" |
| | 2 | 92 | | :root { |
| | 2 | 93 | | --scalar-sidebar-width: 300px; |
| | 2 | 94 | | } |
| | 2 | 95 | | "; |
| | 4 | 96 | | }); |
| | 2 | 97 | | } |
| | | 98 | | |
| | | 99 | | public static void UseDocs(this IApplicationBuilder app) |
| | | 100 | | { |
| | 2 | 101 | | app.UseStaticFiles(); |
| | 2 | 102 | | app.UseSwagger(); |
| | 2 | 103 | | } |
| | | 104 | | |
| | | 105 | | private static string ReadResource(string name) |
| | | 106 | | { |
| | 2 | 107 | | var assembly = Assembly.GetExecutingAssembly(); |
| | 10 | 108 | | var resourcePath = assembly.GetManifestResourceNames().Single(str => str.EndsWith(name)); |
| | | 109 | | |
| | 2 | 110 | | using Stream stream = assembly.GetManifestResourceStream(resourcePath)!; |
| | 2 | 111 | | using StreamReader reader = new(stream); |
| | | 112 | | |
| | 2 | 113 | | return reader.ReadToEnd(); |
| | 2 | 114 | | } |
| | | 115 | | } |