如何在C#中创建APi?

时间:2012-07-07 12:39:24

标签: c# .net api

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

基本上我对如何继续使用API​​一无所知。任何形式的例子对我都有好处。

5 个答案:

答案 0 :(得分:24)

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

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

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

这意味着您希望遵循UI / UX设计的所有一般原则 - 可发现性,使常见任务变得简单等。

利用XML注释确保文档始终存在。确保最常见的任务易于执行,并且显而易见的是如何执行此操作。使异常清理并包含有用的,可操作的错误消息。想一想什么会让消费者的生活变得更轻松。

答案 1 :(得分:8)

在C#中创建API并不是什么大问题,但制作一个好的API是一个很好的挑战。

如果要将程序集作为API分发,则必须在Visual Studio中添加Class Library Project

或者,如果您希望将API公开为服务,则可以考虑WCFWeb Api

  

要制作优质且高效的API,您必须学习Framework Design Guidlines

答案 2 :(得分:5)

你的问题很少......

但是我试着回答你。看看您是否要创建可以通过HTTP调用的API,然后您可以使用WCF执行此操作..

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

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

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

谢谢,

答案 3 :(得分:1)

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

首先:在界面中思考。编写可供其使用的接口 需要你提供的功能。

而且:保持简单!

最好在开发API时编写两个项目。

  1. 您的用户将使用的API
  2. 已使用您的API的示例项目/测试项目。
  3. 这样,您将获得完整的API和一些示例 显示您认为应如何使用您的API,价值超过 任何文档,作为一个简单的例子讲述的不仅仅是描述。 (当然,您仍然应该描述您的API 可以做什么)

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

    玩得开心!

答案 4 :(得分:0)

如果您想了解一些重要内容,我可以推荐this Framework Design Guidelines book。即使您不打算设计自己的框架,它也很有趣,它确实提供了一些很好的见解,为什么应该做出一些决定而另一些决策不应该。