#npm 包 wrasse 使用教程

介绍

wrasse 是一款针对前端项目的命令行工具，可以帮助前端开发者快速搭建项目工程，增强开发效率。这个包非常小巧但十分实用，是开发AJAX和RESTful JSON API的不二之选。

本文将详细介绍 wrasse 的使用方法，并支持一些示例代码，帮助读者更好地入门和使用该工具。

安装

wrasse 可以通过 npm 获得, 来全局安装 wrasse。

npm install -g wrasse

使用

1. 创建项目

在你想要放置项目工程的文件夹中输入如下命令：

wrasse new myproject

其中 myproject 是你想要指定的项目名称。执行此命令之后，wrasse 将创建一个myproject 的基本项目框架

2. 创建一个管理条目

wrasse 允许你快速创建管理条目，让你在开发过程中更加有效率。在myproject 目录下运行以下命令：

wrasse g resource person name:string age:number

这条命令使用了 wrasse 的 generate Wrasse 命令。它将创建一个person的 RESTful JSON API，拥有两个属性—— name 和age， 分别为字符串和数字属性类型，并且包含了与此相关的路由和控制器。

3. 启动服务

在创建完项目工程和管理条目之后，我们需要 start Wrasse 服务来启动我们的 API。

wrasse start

这将启动我们在 myproject 中创建的基本 API。如果我们在浏览器中输入 http://localhost:3000/ 我们将看到 wrasse 在隐藏的 /api/ 前缀下注册的 API 服务。使用该 API 可以创建和管理 person 资源。

4. 测试

我们可以使用 curl 命令来测试我们的 API。

• 创建 person：

$ curl -H "Content-Type: application/json" -X POST -d "{\"name\":\"hello\", \"age\":28}" http://localhost:3000/api/persons

• 获取 person：

$ curl http://localhost:3000/api/persons/1

• 更新person：

$ curl -H "Content-Type: application/json" -X PUT -d "{\"name\":\"olleh\", \"age\":82}" http://localhost:3000/api/persons/1

5. 生成 Swagger 文档

wrasse 支持 Swagger，为用户提供交互式 API 文档。在myproject目录下运行以下命令：

wrasse swagger

该命令将在生成的/myproject/public/swagger.json 文件中生成 API 文档，该文件遵循 SwaggerJSON 规范。

6. 生成 TypeScript 声明

你也可以使用 generateWrasse 命令来生成 TypeScript 接口定义，该命令会生成一个.d.ts 文件。

wrasse typescript person

这将为我们的 person 资源生成一个 TypeScript 声明。保存在 public/person.d.ts 文件中。

总结

wrasse 是一款非常优秀而且实用的命令行工具，可以极大提高我们前端开发的效率。在这篇介绍文章中，我们已经详细介绍了它的使用方法，并提供了一些示例代码以帮助读者可以轻松上手使用。如果你是一位前端开发者，那么 wrasse 绝对是你不可或缺的助手之一。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671188dd3466f61ffe757