# 基本配置

# 接口添加注释

右键web 项目名称=>属性=>生成,

  • 勾选"输出"下面的"xml"文档文件,系统会默认生成一个,当然可以自己设置
  • 忽略注释警告:在取消显示警告添加 ;1591
  • 添加设置信息
var basePath = AppContext.BaseDirectory;
var xmlPath = Path.Combine(basePath, "Sylone.xml");//这个就是刚刚配置的xml文件名
c.IncludeXmlComments(xmlPath);

# 发布后的项目打开Swagger

通常会在代码中限制ASPNETCORE_ENVIRONMENT为Production时关闭swagger。但是往往我们需要将api发布到本地iis调试或供他人使用时,swagger将会被禁止。发布后项目往往默认为Production环境,将其修改为Development即可解决。

  • 1、打开发布到iis的文件夹下的web.config文件,添加以下代码:
<environmentVariables>
     <environmentVariable name="ASPNETCORE_ENVIRONMENT" value="Development" />
</environmentVariables>
  • 2、修改后的web.config结构大致如下:











 
 
 





<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <location path="." inheritInChildApplications="false">
    <system.webServer>
      <handlers>
        <add name="aspNetCore" path="*" verb="*" modules="AspNetCoreModuleV2" 
		     resourceType="Unspecified" />
      </handlers>
      <aspNetCore processPath="dotnet" arguments="*.dll" 
	              stdoutLogEnabled="false" 
				  stdoutLogFile=".\logs\stdout" hostingModel="InProcess">
      <environmentVariables>
        <environmentVariable name="ASPNETCORE_ENVIRONMENT" value="Development" />
      </environmentVariables>
    </aspNetCore>
    </system.webServer>
  </location>
</configuration>