Microsoft.OData.Cli 0.3.1

OData 代码生成器工具

组件	构建	状态
连接的服务	滚动

简介

这是官方 OData 代码生成器工具存储库。OData 代码生成器工具允许用户从 OData 元数据生成代理类。这些代理类由 OData 客户端用于与 OData 服务交互。这些工具适用于 VB.NET 和 C# 项目。

此存储库中的 OData 代码生成器工具有

1. OData 连接服务
2. OData CLI。

这些工具使得应用程序开发人员可以将他们的应用程序连接到 OData 服务（V3 和 V4），并生成服务的客户端代理文件。

OData 连接服务支持 Visual Studio 2017、Visual Studio 2019 和 Visual Studio 2022。

此项目已准备好在生产环境中使用，并目前正在积极支持中。

想了解更多关于 OData 的信息，请访问 OData 网站。想了解更多关于 Microsoft OData 库的信息，请访问 此处文档。

为什么需要 OData 代码生成器工具？

您是否希望在您的 Microsoft .NET 应用程序中集成 OData 服务？OData 代码生成器工具可以让您的生活变得简单，因为您可以使用它们自动生成代理类，这些类更容易调用。这些工具能够快速生成和更新这些类的功能，使您的开发更快。请查看文档中的以下内容，了解如何操作：

1. 如何安装和使用连接服务生成这些类.

2. 如何安装和使用 OData CLI 生成这些类.

入门指南

要开始使用这些OData代码生成器工具，请查阅上面共享的文档链接。

OData连接服务扩展

OData连接服务文档和其他工件可以在以下两个地方找到

• 源代码
• Visual Studio扩展
• 发布版
• 文档

OData CLI

OData CLI文档和其他工件可以在以下两个地方找到

• 源代码
• dotnet工具
• EXE文件
• 文档

构建

为了构建应用，推荐使用已安装VSIX开发工具的Visual Studio 2019/2017/2022作为开发环境。

此存储库在一个解决方案中包含6个项目。这些项目是：

1. Microsoft.OData.Cli
2. Microsoft.OData.CodeGen
3. ODataConnectedService
4. ODataConnectedService.Shared
5. ODataConnectdService.Tests
6. ODataConnectedService.VS2022Plus

在Visual Studio中构建

在Visual Studio中打开ODataCodeGenTools.sln，并安装可能缺失的任何扩展。构建并运行项目。

在开发过程中，如果遇到任何问题，请检查下面的常见问题解答部分。

单元测试

ODataConnectedService.Tests项目包含OData连接服务的单元测试。测试的文件夹结构反映了ODataConnectedService.Shared项目的文件夹结构。测试的基本命名空间为Microsoft.OData.ConnectedService.Tests。此外，每个测试类的名称与其测试的类的名称相同，后面跟有后缀Test。

示例：对于位于src\X\Y.cs中的某个类Microsoft.OData.ConnectedService.X.Y，测试类将是位于test\X\YTest.cs的Microsoft.OData.Tests.ConnectedService.Tests.X.YTest。

构建命令行

可以通过结合提供的build.cmd在命令行上构建项目。

其他相关项目

• Microsoft OData库
• Microsoft WebAPI库
• Microsoft Restier

常见问题解答

问题：在Visual Studio实验实例中进行调试时，扩展模块没有加载，或者它没有被列为“添加连接服务”选项的一部分。解决方案：禁用主和测试程序集的强名称验证。您可以使用Visual Studio开发者命令提示中的sn.exe工具这样做。首先，使用Visual Studio构建解决方案，然后以管理员权限打开开发人员命令提示，并运行以下命令

对于主程序集

sn.exe -Vr path\to\ODataConnectedService\src\bin\Debug\Microsoft.OData.ConnectedService.dll

对于测试程序集

sn.exe -Vr path\to\ODataConnectedService\test\ODataConnectedService.Tests\bin\Debug\ODataConnectedServiceTests.dll

然后重新启动Visual Studio。

如果禁用验证不可行，您可以禁用签名，方法是在项目属性中转到签名并禁用“签名程序集”和“仅延迟签名”选项。对主和测试项目都这样做。然后打开解决方案资源管理器中主项目属性下的AssemblyInfo.cs文件，并从[assembly: InternalsVisibleTo("ODataConnectedService.Tests, PublicKey=...")]属性中移除公钥，使其仅读取为[assembly: InternalsVisibleTo("ODataConnectedService.Tests")]。请记住，在提交更改之前重新启用延迟签名并恢复公钥。

问题：在Visual Studio 2017中，当配置OData连接服务的服务端点并在单击“完成”后，我得到一个错误消息，表明“无法访问”。
解决方案：此错误的大多数报告问题都与基于身份验证的端点相关。此扩展目前不支持身份验证。为此，从端点下载元数据作为文本文件，然后将OData连接服务的URI指向下载的文件。

OData连接服务的概要路线图

OData连接服务被认为是一个稳定的产品。以下是计划的一些改进

• 使代码生成器跨平台。这是为了照顾在非Windows环境中使用Visual Studio Code的开发者。
• 从命令行生成代码并随后在构建管道中生成代码更加无缝，从而增强自动化。

贡献

您有多种方式可以为OData Connected服务做出贡献。最简单的方式是参与功能和问题的讨论。您还可以通过向我们发送功能或错误修复的拉取请求来做出贡献。对文档的贡献也备受欢迎。有关更多详细信息，请参阅CONTRIBUTING.md。

报告安全问题

安全问题和错误应通过电子邮件私下报告给微软安全响应中心（MSRC）[email protected]。您应在24小时内收到回复。如果您因任何原因没有收到回复，请通过电子邮件跟进以确保我们已经收到了您的原始信息。更多信息，包括MSRC PGP密钥，可以在安全技术中心找到。您也可以在本存储库的SECURITY.md中找到这些说明。

支持

• 问题：在Github问题报告问题。
• 问题：在Stack Overflow提问。
• 反馈：请发送邮件到[email protected]。
• 团队博客：请访问https://docs.microsoft.com/odata/、https://www.odata.org/blog/和https://devblogs.microsoft.com/odata/。

行为准则

本项目遵循.NET Foundation贡献者行为准则。有关更多信息，请参阅行为准则常见问题解答。

.NET Foundation

本项目得到.NET Foundation的支持。

OData Connected Service是版权所有 © .NET Foundation和其他贡献者。它在MIT许可下发布。