广安市建设局新网站,营销网站建设情况调查问卷,怎么做企业网站,优秀网站建设报价NSwag 提供了下列功能#xff1a;能够使用 Swagger UI 和 Swagger 生成器。灵活的代码生成功能。借助 NSwag#xff0c;无需使用现有 API。也就是说#xff0c;可使用包含 Swagger 的第三方 API#xff0c;并生成客户端实现。 使用 NSwag#xff0c;可以加快开发周期… NSwag 提供了下列功能能够使用 Swagger UI 和 Swagger 生成器。灵活的代码生成功能。借助 NSwag无需使用现有 API。也就是说可使用包含 Swagger 的第三方 API并生成客户端实现。 使用 NSwag可以加快开发周期并轻松适应 API 更改。注册 NSwag 中间件注册 NSwag 中间件即可生成已实现的 Web API 的 Swagger 规范。为 Swagger UI 提供服务以浏览和测试 Web API。若要使用 NSwag ASP.NET Core 中间件请安装 NSwag.AspNetCore NuGet 包。 此包内的中间件可用于生成并提供Swagger 规范、Swagger UIv2 和 v3和 ReDoc UI。若要安装 NSwag NuGet 包请使用以下方法之一从“程序包管理器控制台”窗口转到“视图” “其他窗口” “程序包管理器控制台”导航到包含 TodoApi.csproj 文件的目录请执行以下命令Install-Package NSwag.AspNetCore从“管理 NuGet 程序包”对话框中右键单击“解决方案资源管理器” “管理 NuGet 包”中的项目将“包源”设置为“nuget.org”在搜索框中输入“NSwag.AspNetCore”从“浏览”选项卡中选择“NSwag.AspNetCore”包然后单击“安装”添加并配置 Swagger 中间件通过在 Startup 类中执行以下步骤在 ASP.NET Core 应用中添加和配置 Swagger导入下列命名空间using NJsonSchema;using NSwag.AspNetCore;在 ConfigureServices 方法中注册所需的 Swagger 服务public void ConfigureServices(IServiceCollection services){ services.AddDbContextTodoContext(opt opt.UseInMemoryDatabase(TodoList)); services.AddMvc();// Register the Swagger services services.AddSwaggerDocument();}在 Configure 方法中启用中间件为生成的 Swagger 规范和 Swagger UI 提供服务public void Configure(IApplicationBuilder app){ app.UseStaticFiles();// Register the Swagger generator and the Swagger UI middlewares app.UseSwagger(); app.UseSwaggerUi3(); app.UseMvc();}启动应用。 转到http://localhost:port/swagger以查看 Swagger UI。http://localhost:port/swagger/v1/swagger.json以查看 Swagger 规范。代码生成若要利用 NSwag 的代码生成功能可选择以下选项之一NSwagStudio – 一款 Windows 桌面应用用于以 C# 或 TypeScript 生成 API 客户端代码。NSwag.CodeGeneration.CSharp 或 NSwag.CodeGeneration.TypeScript NuGet 包 - 用于在项目中生成代码。通过命令行使用 NSwag。NSwag.MSBuild NuGet 包。使用 NSwagStudio 生成代码按照 NSwagStudio GitHub 存储库中的说明操作以安装 NSwagStudio。启动 NSwagStudio并在“Swagger 规范 URL”文本框中输入 swagger.json 文件 URL。 例如http://localhost:44354/swagger/v1/swagger.json。单击“创建本地副本”按钮以生成 Swagger 规范的 JSON 表示形式。在“输出”区域中单击选中“C# 客户端”复选框。 也可以选中“TypeScript 客户端”或“C# Web API 控制器”具体视项目而定。 如果选中“C# Web API 控制器”服务规范会重新生成服务起到反向生成的作用。单击“生成输出”以生成 TodoApi.NSwag 项目的完整 C# 客户端实现。 若要查看生成的客户端代码请单击“C# 客户端”选项卡//----------------------// auto-generated// Generated using the NSwag toolchain v12.0.9.0 (NJsonSchema v9.13.10.0 (Newtonsoft.Json v11.0.0.0)) (http://NSwag.org)// /auto-generated//----------------------namespace MyNamespace{#pragma warning disable [System.CodeDom.Compiler.GeneratedCode(NSwag, 12.0.9.0 (NJsonSchema v9.13.10.0 (Newtonsoft.Json v11.0.0.0)))]public partial class TodoClient {private string _baseUrl https://localhost:44354;private System.Net.Http.HttpClient _httpClient;private System.LazyNewtonsoft.Json.JsonSerializerSettings _settings;public TodoClient(System.Net.Http.HttpClient httpClient){ _httpClient httpClient; _settings new System.LazyNewtonsoft.Json.JsonSerializerSettings(() {var settings new Newtonsoft.Json.JsonSerializerSettings(); UpdateJsonSerializerSettings(settings);return settings; }); }public string BaseUrl {get { return _baseUrl; }set { _baseUrl value; } }// code omitted for brevity 提示C# 客户端代码的生成依据是“设置”选项卡中的选择。修改设置以执行任务例如默认命名空间重命名和同步方法生成。将生成的 C# 代码复制到使用 API 的客户端项目内的文件中。开始使用 Web API var todoClient new TodoClient();// Gets all to-dos from the APIvar allTodos await todoClient.GetAllAsync();// Create a new TodoItem, and save it via the API.var createdTodo await todoClient.CreateAsync(new TodoItem());// Get a single to-do by IDvar foundTodo await todoClient.GetByIdAsync(1);自定义 API 文档Swagger 提供用于记录对象模型以便于使用 Web API 的选项。API 信息和说明在 Startup.ConfigureServices 方法中传递给 AddSwaggerDocument 方法的配置操作会添加诸如作者、许可证和说明的信息services.AddSwaggerDocument(config { config.PostProcess document { document.Info.Version v1; document.Info.Title ToDo API; document.Info.Description A simple ASP.NET Core web API; document.Info.TermsOfService None; document.Info.Contact new NSwag.SwaggerContact { Name Shayne Boyer, Email string.Empty, Url https://twitter.com/spboyer }; document.Info.License new NSwag.SwaggerLicense { Name Use under LICX, Url https://example.com/license }; };});Swagger UI 显示版本的信息XML 注释若要启用 XML 注释请执行以下步骤Visual StudioVisual Studio for MacVisual Studio Code在“解决方案资源管理器”中右键单击该项目然后选择“编辑 project_name.csproj”。手动将突出显示的行添加到 .csproj 文件PropertyGroup GenerateDocumentationFiletrue/GenerateDocumentationFileNoWarn$(NoWarn);1591/NoWarn/PropertyGroup数据注释由于 NSwag 使用反射且建议的 Web API 操作返回类型为 ActionResultT因此只能推断 T 定义的返回类型。 无法自动推断其他可能的返回类型。请看下面的示例[HttpPost]public ActionResultTodoItem Create(TodoItem item){ _context.TodoItems.Add(item); _context.SaveChanges();return CreatedAtRoute(GetTodo, new { id item.Id }, item);}上述操作将返回 ActionResultT。 在操作中它将返回 CreatedAtRoute。 由于使用 [ApiController] 属性修饰控制器所以也可能出现 BadRequest 响应。 有关详细信息请参阅自动 HTTP 400 响应。 使用数据注释告知客户端已知此操作会返回哪些 HTTP 状态代码。 使用以下属性修饰该操作[ProducesResponseType(201)] // Created[ProducesResponseType(400)] // BadRequest在 ASP.NET Core 2.2 或更高版本中可使用约定而不是使用 [ProducesResponseType] 显式修饰各操作。 有关更多信息请参见使用 Web API 约定。Swagger 生成器现在可准确地描述此操作且生成的客户端知道调用终结点时收到的内容。 建议使用这些属性来修饰所有操作。有关 API 操作应返回的 HTTP 响应的指导原则请参阅 RFC 7231 规范。原文地址https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/getting-started-with-nswag.NET社区新闻深度好文欢迎访问公众号文章汇总 http://www.csharpkit.com
