在前端开发中，许多人可能没听说过 @microsoft.azure/codegen-csharp 这个 npm 包，但它实际上是一个非常有用的工具，可以极大地加速 .NET Core Web API 的开发。本教程将详细介绍如何使用 @microsoft.azure/codegen-csharp，包括安装，使用示例，以及最佳实践。
安装
首先，我们需要全局安装 @microsoft.azure/codegen-csharp：
npm install -g @microsoft.azure/codegen-csharp
这将在全局范围内安装 @microsoft.azure/codegen-csharp，以便我们在任意位置使用它。
使用示例
下面，我们将使用一个简单的示例介绍如何使用 @microsoft.azure/codegen-csharp。
首先，我们需要定义一个 OpenAPI 规范的 JSON 文件，例如这个文件：
-- -------------------- ---- -------
-
---------- --------
------- -
-------- --------- -----
---------- -------
--
-------- -
-------- -
------ -
-------------- ----------
------------ -
------ -
-------------- -- ---- -- -------
---------- -
------------------- -
--------- -
------- --------
-------- -
------- --------------------------
-
-
-
-
-
-
-
-
--
------------- -
---------- -
------ -
------- ---------
----------- -
-----
------
--
------------- -
----- -
------- ----------
--------- -------
--
------- -
------- --------
--
------ -
------- --------
-
-
-
-
-
-然后，我们可以使用 @microsoft.azure/codegen-csharp 生成 C# 代码：
autorest --input-file=openapi.json --namespace=PetStore --output-folder=PetStore --csharp --add-credentials
这将在当前目录下生成一个名为 PetStore 的文件夹，其中包含根据 OpenAPI 规范自动生成的 C# 代码。
接下来，我们可以将生成的代码集成到我们的 .NET Core Web API 项目中。在 Visual Studio 中打开项目，右键单击“解决方案资源管理器”中的“依赖项”文件夹，然后选择“添加引用”。在添加引用对话框中选择“浏览”，然后选择生成的 PetStore.dll 文件。现在，我们可以在我们的项目中使用生成的代码，例如这个控制器：
-- -------------------- ---- -------
----- ---------------------------
----- -------------------------
----- ---------
--------- --------------------
-
---------------
-----------------------
------ ----- ------------------ - --------------
-
------- -------- -------------- ----------
------ --------------------------------- ---------
-
--------- - ---------
-
---------
------ ---------------- -----
-
------ --------------------------
-
-
-现在，我们可以启动我们的 .NET Core Web API 项目，并使用浏览器或 API 调试工具访问 http://localhost:5000/petstore，即可查看所有的宠物列表。
最佳实践
使用 @microsoft.azure/codegen-csharp 可以大大简化 .NET Core Web API 的开发，但也应该注意一些最佳实践。
首先，我们应该将 OpenAPI 规范视为项目的一部分，并使用版本控制系统进行管理。这样一来，我们就可以追踪规范的更改，并确保生成的代码与规范的一致性。
其次，我们应该注意生成的 C# 代码的可维护性。尽管 @microsoft.azure/codegen-csharp 可以自动生成大量代码，但这并不意味着我们可以忽略代码的质量。因此，我们应该使用良好的命名约定，保持代码的清晰度和一致性，并遵循最佳实践。
最后，我们应该注意代码的正确性和性能。在使用自动生成的代码的同时，我们也应该审查其正确性和性能，确保其能够满足我们的需求。
结论
在本教程中，我们详细介绍了如何使用 @microsoft.azure/codegen-csharp 来加速 .NET Core Web API 的开发。我们介绍了它的安装，使用示例以及一些最佳实践。尽管自动生成的代码可以大大简化开发过程，但我们仍然应该注意代码的质量、正确性和性能。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600673e0fb81d47349e53cd2