daohualiuxiang
/
AspNetCore.Docs
mirror of https://github.com/dotnet/AspNetCore.Docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add notice regarding undocumented methods notices and updated code (#5089) 

* add notice regarding undocumented methods notices and updated code for pointing to the xml file

* Update web-api-help-pages-using-swagger.md

* cleanup using in startup.cs and updated notice message regarding missing xml comment

* add missing startup.cs changes

* Minor edit
pull/5136/head
Alexandru Bucur 2018-01-08 18:15:17 +02:00 committed by Scott Addie
parent ccbded790f
commit ae5d14d6a0
2 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
aspnetcore/tutorials/web-api-help-pages-using-swagger.md
View File

@ -223,6 +223,8 @@ See Visual Studio Code.
---
Enabling XML comments provides debug information for undocumented public types and members. Undocumented types and members are indicated by the warning message: *Missing XML comment for publicly visible type or member*.
Configure Swagger to use the generated XML file. For Linux or non-Windows operating systems, file names and paths can be case sensitive. For example, a *ToDoApi.XML* file would be found on Windows but not CentOS.
[!code-csharp[Main](../tutorials/web-api-help-pages-using-swagger/sample/TodoApi/Startup.cs?name=snippet_ConfigureServices&highlight=20-22)]

9
aspnetcore/tutorials/web-api-help-pages-using-swagger/sample/TodoApi/Startup.cs
View File

@ -1,4 +1,5 @@
using System.IO;
using System;
using System.IO;
using Microsoft.AspNetCore.Builder;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;
@ -9,7 +10,7 @@ using TodoApi.Models;
namespace TodoApi
{
public class Startup
{
{
#region snippet_ConfigureServices
public void ConfigureServices(IServiceCollection services)
{
@ -30,9 +31,9 @@ namespace TodoApi
});
// Set the comments path for the Swagger JSON and UI.
var basePath = PlatformServices.Default.Application.ApplicationBasePath;
var basePath = AppContext.BaseDirectory;
var xmlPath = Path.Combine(basePath, "TodoApi.xml");
c.IncludeXmlComments(xmlPath);
c.IncludeXmlComments(xmlPath);
});
}
#endregion