20

我一直在做编程，但现在我面临一个挑战。我在一个项目中，我必须在 C# 中为我的用户创建一个 API。基本过程是我有一个 C# 代码，我在其中读取 XML 文件并获取标签之间的属性和值。我实现了这一点，现在我必须为相同的功能创建可消耗的 API。有什么方法可以让我学习创建 API？

基本上我不知道如何继续使用 API。任何类型的例子都会对我有用。

4

5 回答 5

33

API 只是其他程序员与您的代码交互的一种方式。AC# 类库可以是 API，Web 服务、WCF 端点等也可以。最简单的方法是创建一个 C# 类库项目，确保它具有公共方法，并将其编译为 .dll您可以分发。

正如其他人所提到的，框架设计指南对于遵循一些规则很有用。

要记住的一件事——我希望这会被所有新的软件开发人员所重视——是 API 设计从根本上说是一个可用性问题。您正在为软件的用户构建 UI，而您的用户是其他程序员。

这意味着您要遵循 UI/UX 设计的所有一般原则——可发现性、简化常见任务等。

利用 XML 注释确保文档始终存在。确保最常见的任务很容易执行，并且很明显如何执行。清除异常并包含有用的、可操作的错误消息。想想什么会让消费者的生活更轻松。

于 2012-07-07T13:03:04.557 回答
8

用 C# 制作 API 没什么大不了的，但制作一个好的 API 是一个很大的挑战。

如果要将程序集作为 API 分发，则只需在 Visual Studio 中添加一个类库项目。

或者，如果您想将 API 公开为服务，则可以考虑WCF和Web Api。

要制作一个好的和高效的 API，你必须学习框架设计指南

于 2012-07-07T12:42:52.123 回答
5

你的问题有点笼统..

不过我试着回答你。看看你是否想创建可以通过 HTTP 调用的 API，那么你可以使用 WCF 来做到这一点。

您可以在 wcftutorial.net 上阅读有关 WCF 的信息

您也可以使用 DLL 创建 API，我建议您阅读 http://www.c-sharpcorner.com/UploadFile/mahesh/dll12222005064058AM/dll.aspx

快速了解如何使用 Visual C# 创建 DLL。

谢谢，

于 2012-07-07T12:45:58.810 回答
1

如果您想创建一个易于使用的 API，这可能是一个挑战。

首先：考虑接口。编写可供需要您提供的功能的人使用的接口。

并且：保持简单！

充其量，您在开发 API 时编写两个项目。

  1. 您的用户将使用的 API
  2. 已经使用您的 API 的示例项目/测试项目。

这样，您最终将获得一个完整的 API 和一些示例，这些示例展示了您认为应该如何使用您的 API，比任何文档都更有价值，因为一个简单的示例比描述更能说明问题。（当然，你还是要描述你的 API能做什么）

在您的 API 中提供可以按原样使用的类，即您的 API 的用户不得提供您可以在 API 中执行的操作。

玩得开心！

于 2012-07-07T12:54:26.160 回答
0

如果你想对重要的事情有一些基本的了解，我可以推荐这本框架设计指南书。即使您不打算设计自己的框架，阅读它也很有趣，并且它确实提供了一些关于为什么应该做出某些决定而不应该做出其他决定的一些很好的见解。

于 2012-07-07T13:04:49.717 回答