如何开始为php MVC自己创建的框架编写SDK

时间:2014-10-09 19:37:07

标签: php api rest sdk

我不知道如何实际问我的问题,但是来了:

我的老板希望我为我们的在线购物网站创建一个简单的使用PHP的MVC ,我做到了(看youtube和......),它非常简单易用。

现在他不停地问我:

首先创建一个RESTful API(使用curl)。

第二次创建一个记录良好的SDK !!。

我经常搜索(真的),知道我能理解API的作用 但我不确定什么是SDK以及如何开始编写代码

有人能给我一行代码如何开始写吗?

他的意思是**记录良好**?

我在谷歌搜索过,我知道什么是SDK和API字面意思,但我的问题是我无法建立我的MVC与API和SDK之间的关系。

如何开始编写API?

我应该从哪里开始?

有什么意义?

有人可以举个例子吗?

我的SDK应该做什么?

我见过很多关于API的视频,所有关于使用REST和REST的讨论非常好,我们应该使用GET / POST / DELETE / PUT等等来强迫。

但我应该从哪里开始?

修改

就我而言,只是通过我们的MongoDB数据库搜索并返回新产品和其他一些简单任务的在线购物,我该如何使用RESTful API?还是SKD?

谢谢,如果解释不明白,请告诉我。

1 个答案:

答案 0 :(得分:3)

看起来你面前有一项任务。

Restful Routing

Restful routing是一种通过标准HTTP protocols与服务器通信的方式。这些内容包括GETPOSTPUTDELETE等等。

以宁静的方式进行路由时,您无需调用不明确的方法来检索,更新或删除服务器上的数据。

例如,在尝试从服务器检索用户时,您可能会调用http://domain.tld/getAllUsers.php。这不太安宁。

但是,如果您通过拨打http://domain.tld/users/来检索所有用户,并指定要通过内置于GET的{​​{1}}来访问此来电,则会是HTTP protocol

网上有很多资源可以了解有关restful的更多信息。

的API

restful routingAPIs。例如,当您使用Application Programming Interafaces构建应用程序时,您还实现了restful routing,因为您正在为其他人提供访问服务器上数据的方法。

但是,所有API都不是APIs。事实上,很多都不是,restful学习这些更难,因为他们不遵循application programmers

有很多关于standard的书籍,这比我在这个回复中可以涵盖的还要多。我推荐的一本书是Phil Sturgeon的APIs

的SDK

Build APIs You Won't HateSDKs,虽然大部分时间非常广泛,但您将要开发的Software Development Kits将构成restful API

这可能不是你老板想要的,这是你不得不问他的。

文档

记录良好的代码易于阅读且易于理解。这需要非常好地掌握目标受众使用的语言。

编写优秀文档的第一步是撰写评论良好的代码。 拥有良好评论的代码是您可以拥有的最佳文档,在编写完成后,您可以使用SDK等工具可为您生成文档。这一代可能没有你想要的那么广泛,这只意味着你需要更多的评论。

一些建议

通读其他开发人员的代码 已经实现了您正在寻找的东西。我在这个例子中有偏见,因为它是我当前选择的框架,但Laravel是一个PHPDoc,可以很好地完成所有这些。代码也有详细记录,易于理解。

此外,Packagist上有很多写得很好的软件包可能对您有所帮助,如果您还没有,请查看它们并查看Composer

如果有人在阅读此内容时发现错误,请更正我。