您需要采取哪些步骤/流程来创建API

时间:2012-09-18 06:19:07

标签: php api oop web-applications social-networking

我需要采取哪些步骤/流程来规划为我的网站(使用PHP和SQL技术)创建API?另外,我需要知道哪些信息?

例如,步骤1:创建索引页面,步骤2:创建此组或库代码等...

我正在从头开始创建一个社交网站,我希望在alpha阶段实现API。我假设我需要使应用程序对象面向我没有问题。但是你究竟从API实施过程开始呢?

3 个答案:

答案 0 :(得分:2)

首先:确定为什么你真的需要这个API。如果您要生成一些使用此API本身的客户端应用,那么这是一个很好的理由。如果您希望一旦您的服务变得受欢迎,某人会使用该API做有趣的事情,这是一个不好的理由。您只需花费很长时间在API上工作,而无需任何人想要使用它。让您的服务变得流行,并首先评估对API的兴趣。

话虽如此,API只是您网站上的另一个URL,您可以使用结构化,机器可读的XML或JSON(或其他格式)提供数据,它与为您提供的HTML文档完全没有任何区别常规页面 主要区别在于API需要精心设计并且稳定。您可以随心所欲地重新设计HTML,但是一旦编写了客户端来使用您的API,它就不会在未来一段时间内发生变化。因此,您需要很好地规划API的使用和数据格式。如果你很清楚它将用于什么,这将更容易。详细研究其他大型服务的现有API,看看它们是如何解决一些细节的。

在内部,您需要模块化地构建应用程序。使用例如MVC模式正确地分离关注点。您将在模型中拥有核心逻辑,并且您将拥有两个(或更多)视图;一个常规HTML视图和一个JSON / XML API视图,用于大致相同的数据。这意味着:不要将任何重要逻辑与您的HTML混合,您必须在API视图中复制这些逻辑。

答案 1 :(得分:1)

对于PHP,请尝试http://laravel.com/ - https://tutsplus.com/lesson/restful-controllers/获取教程。关于使用laravel作为backbonejs后端有一个很好的nettuts视频,但我找不到它。

答案 2 :(得分:1)

您还可以尝试后端即服务提供商为您的数据模型自动生成休息接口。例如。 www.apiomat.com提供生成的php-client代码来访问生成的REST接口。