如何在C#中创建APi？

Question

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

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

Answer 1

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

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

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

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

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

Answer 2

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

如果要将程序集作为API分发,则必须在Visual Studio中添加类库项目.

或者,如果您希望将API公开为服务,那么您可以考虑使用WCF和Web Api.

要创建一个优秀而有效的API,您必须学习框架设计指南

Answer 3

你的问题很少见..

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

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

快速入门,了解如何使用Visual C#创建DLL.

谢谢,