Abp中SwaggerUI的接口說明文檔配置

項目中集成了swashbuckle，那么通過訪問http://ip:port/swagger/ui/index，可以看到提供的接口列表。接口列表默認是沒有提供接口說明信息的，但是swagger內部是集成了一個方法，可以通過讀取xml文檔添加接口說明。

 

下面是操作步驟：

1. 設置項目屬性 > 生成，勾選XML文檔文件。這樣在制定文件目錄下就可以生成代碼的注釋xml文件了。

 

2. 提供方法讀取這個xml文檔。

private static List<string> GetXmlCommentsPath()
{
List<string> docs = new List<string>();
var modules = AbpModule.FindDependedModuleTypesRecursivelyIncludingGivenModule(typeof(AbpZeroTemplateWebApiModule));
var baseDirectory = AppDomain.CurrentDomain.BaseDirectory;
 
foreach (var module in modules)
{
var commentsFileName = module.Assembly.GetName().Name + ".XML";
var commentsFile = Path.Combine(baseDirectory, "bin", commentsFileName);
docs.Add(commentsFile);
}
 
return docs;
//return String.Format(@"{0}\bin\SwaggerUi.XML", System.AppDomain.CurrentDomain.BaseDirectory);
}

 

3. 添加一個SwaggerDocHelper.cs。

public class SwaggerDocHelper
{
public static void ConfigXmlCommentsPath(SwaggerDocsConfig config, List<string> docs)
{
foreach (var doc in docs)
{
if (FileUtils.IsFileExists(doc))
{
config.IncludeXmlComments(doc);
}
}
config.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());
 
}
}

 

4. 配置swagger讀取文檔。

 

ok，到這里就配置成功了。檢驗下效果：