如何从头开始创建 Ax API？

什么是 Ax API？

        Ax API 是通过仅定义数据库模型和它们之间的关系来创建 Rest API 的最快方法。它建立在Knex.js及其令人敬畏的活动记录模式之上。另一方面，您还有另一个熟悉的东西Express。

        Ax API 使您能够将构建 API 的常见任务与业务逻辑分开。Ax API 需要模型定义来分析您的路由结构。创建模型及其之间的关系后，Ax API 可以处理所有众所周知的 API 请求。创建一个包含 5 个表的 API 需要将近 15 分钟。

        昭ř TLY，斧API执行三个基本功能;

• 分析您的模型及其关系以创建路线。
• 处理所有 HTTP 请求。
• 将您的业务逻辑与 API 最佳实践分开。

安装

        在应用程序中使用 Ax API 非常简单。我们为您创建了一个 CLI 工具；斧魔

       您可以使用以下命令将 axe-magic 安装到您的机器上；

<span style="background-color:#f2f2f2"><span style="color:rgba(0, 0, 0, 0.8)"><span style="color:#292929">$ npm i -g axe-magic 
$ axe-magic --version 
1.0.0</span></span></span>

      之后，创建一个新项目非常容易。只需执行以下命令即可；

<span style="background-color:#f2f2f2"><span style="color:rgba(0, 0, 0, 0.8)"><span style="color:#292929">$ axe-magic 新的 my-api</span></span></span>

安装依赖

        要安装项目的依赖项，您可以在根目录中执行以下命令；

<span style="background-color:#f2f2f2"><span style="color:rgba(0, 0, 0, 0.8)"><span style="color:#292929">$ cd my-api 
$ npm 安装</span></span></span>

服务应用程序

        要为该应用程序提供服务，您可以执行以下命令；

<span style="background-color:#f2f2f2"><span style="color:rgba(0, 0, 0, 0.8)"><span style="color:#292929">$ npm run start:dev</span></span></span>

start:dev 命令使用nodemon。如果您还没有安装它，我们建议您先安装它。

        之后，您的第一个 Ax API 应用程序将在localhost:3000 中运行。如果您访问localhost:3000，您将看到以下 API 响应

<span style="background-color:#f2f2f2"><span style="color:rgba(0, 0, 0, 0.8)"><span style="color:#292929">{ 
  "name": "AXE API", 
  "description": "世界上最好的 API 创建工具。", 
  "aim": "杀死他们！" 
}</span></span></span>

        如果您可以看到该响应，则表示您的项目运行正常。七爪网源码交易平台_成品网站源码_小程序源码-七爪网