在asp.net中使用Swagger呈现本地JSON规范的步骤如下:
protected void Application_Start()
{
// 启用Swagger
GlobalConfiguration.Configuration
.EnableSwagger(c => c.SingleApiVersion("v1", "API名称"))
.EnableSwaggerUi();
}
SwaggerConfig.cs
的新文件,并将其添加到App_Start文件夹中。在该文件中,添加以下代码来配置Swagger生成规范和注释:using System.Web.Http;
using Swashbuckle.Application;
namespace YourProjectNamespace
{
public class SwaggerConfig
{
public static void Register(HttpConfiguration config)
{
// 配置Swagger生成规范
config.EnableSwagger(c =>
{
c.SingleApiVersion("v1", "API名称");
c.IncludeXmlComments(GetXmlCommentsPath());
}).EnableSwaggerUi();
}
// 获取XML注释文件的路径
private static string GetXmlCommentsPath()
{
return System.String.Format(@"{0}\bin\YourProjectNamespace.XML",
System.AppDomain.CurrentDomain.BaseDirectory);
}
}
}
Global.asax.cs
文件,并在Application_Start
方法中注册Swagger配置,代码如下:protected void Application_Start()
{
// 启用Swagger
SwaggerConfig.Register(GlobalConfiguration.Configuration);
}
AssemblyInfo.cs
文件,并添加以下代码以生成XML注释文件:using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
[assembly: AssemblyTitle("YourProjectNamespace")]
[assembly: AssemblyDescription("")]
[assembly: AssemblyConfiguration("")]
[assembly: AssemblyCompany("")]
[assembly: AssemblyProduct("YourProjectNamespace")]
[assembly: AssemblyCopyright("")]
[assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")]
// 添加下面这行代码
[assembly: System.Web.Http.Cors.EnableCors("*", "*", "*")]
// 生成XML注释文件
[assembly: System.Web.Http.Cors.EnableCors("*", "*", "*")]
[assembly: ComVisible(false)]
[assembly: Guid("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")]
[assembly: AssemblyVersion("1.0.0.0")]
[assembly: AssemblyFileVersion("1.0.0.0")]
http://localhost:<port>/swagger
)即可查看生成的API文档和JSON规范。需要注意的是,此方法使用的是ASP.NET的Swagger框架和工具。腾讯云的相关产品和链接地址可根据自己的需求和云服务商选择。
没有搜到相关的沙龙
领取专属 10元无门槛券
手把手带您无忧上云