我们如何记录API，或者如何记录一个REST API。

我们可以使用软件或HTML网站维护文档，甚至可以通过代码中的某些工具生成文档。这种方法的缺点是我们需要手动（或通过半自动过程）对文档进行维护，尽管它是人类可读的，但实际上不是机器可读的。

另一种方法是使用WADL，它可以由一些工具生成。在这种情况下，它是机器可读的，但绝对不是人类可读的。另外，手动编写WADL也是一个乏味的过程。

Eolinker为两者寻找一个更简单的解决方案。Eolinker是用于描述REST API的格式的一组规则（换句话说，一种规范）。该格式是机器可读和人类可读的。因此，它可以用于在产品经理，测试人员和开发人员之间共享文档，但也可以被各种工具用来自动化与API相关的流程。

当我们说REST时，我们不一定要遵循RESTful规则。我们引用REST API背后的基本概念。虽然WADL以复杂性为代价涵盖了几乎所有可能的API设计，但Eolinker的目标是涵盖更常见的设计模式，同时简化编写和使用，使其更易于编辑。

为了帮助您了解Eolinker的外观，请看以下示例：

在上面的示例中，我们描述了一个简单的用户登录API。它具有URL、请求参数等信息，还描述了成功的响应。如果“用户”包含无效字符，则会收到一般性400错误。 您还可以看到，在整个操作过程中，我们提供了其他文档。

差不多就是这样-简单地说就是Eolinker。Eolinker规范可供所有人阅读，网址为http://www.Eolinker.com(https://datayi.cn/w/QPDLMwJP) 或阅读此Eolinker教程。它包含有关如何定义路径，参数，响应，模型，安全性等的信息。