eightball/PluralKit
1
0
Fork 0
mirror of https://github.com/PluralKit/PluralKit.git synced 2026-02-04 13:06:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Enable XML comment support for Swashbuckle

Browse source
This commit is contained in:
Ske 2020-05-07 06:09:55 +02:00
parent 5cc5a5b4a7
commit 599dfcc071
2 changed files with 16 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
PluralKit.API/Startup.cs
View file

@ -1,4 +1,6 @@
using System;
using System;
using System.IO;
using System.Reflection;
using Autofac;
@ -60,6 +62,12 @@ namespace PluralKit.API
if (!apiDesc.RelativePath.StartsWith("v1/")) return false;
return apiDesc.GroupName == docName;
});
// Set the comments path for the Swagger JSON and UI.
// https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-3.1&tabs=visual-studio#customize-and-extend
var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
c.IncludeXmlComments(xmlPath);
});
services.AddSwaggerGenNewtonsoftSupport();
}