Quenya 开源项目教程
项目地址: https://gitcode.com/gh_mirrors/qu/quenya 1. 项目介绍
Quenya 是一个基于扩展 OpenAPI 规范构建高质量 REST API 应用程序的框架。它能够生成高质量的代码，涵盖 API 管道的多个部分，包括请求验证、身份验证处理、访问控制、API 处理程序、响应验证等。Quenya 还提供了属性测试，使用 Plug.Test 和 StreamData 生成测试请求，并根据响应模式验证结果。
2. 项目快速启动
安装 Quenya CLI
首先，安装 Quenya CLI：
$ mix archive.install hex quenya_installer
从现有 OAPI 规范生成应用
安装完成后，可以使用 Quenya CLI 从现有的 OAPI 规范生成 API 应用：
$ cd /tmp
$ curl https://raw.githubusercontent.com/tyrchen/quenya/master/parser/test/fixture/petstore.yml > petstore.yml
$ mix quenya.new petstore.yml petstore
运行应用
生成应用后，可以编译并运行应用：
$ cd petstore/
$ mix compile.quenya
$ iex -S mix
访问 Swagger UI
应用启动后，可以通过以下 URL 访问 Swagger UI：
http://localhost:4000/swagger
3. 应用案例和最佳实践
应用案例
Quenya 可以用于快速构建和测试 REST API 应用。例如，使用 Quenya 生成的宠物商店 API 应用可以用于模拟和测试宠物商店的后端服务。
最佳实践
- 使用 Quenya 生成代码：Quenya 能够根据 OpenAPI 规范自动生成大部分 API 代码，减少手动编写代码的工作量。
- 测试驱动开发：Quenya 生成的属性测试可以帮助开发者在编写实际 API 处理逻辑之前，确保 API 的正确性。
- 使用 Swagger UI：Quenya 生成的应用自带 Swagger UI，方便开发者进行 API 测试和文档查看。
4. 典型生态项目
Plug
Plug 是 Elixir 中的一个模块化 HTTP 中间件框架，Quenya 使用 Plug 来构建 API 路由和处理请求。
StreamData
StreamData 是一个属性测试库，Quenya 使用 StreamData 生成测试请求，并验证响应结果。
Cowboy
Cowboy 是一个 Erlang 的 HTTP 服务器，Quenya 生成的应用默认使用 Cowboy 作为 HTTP 服务器。
通过这些生态项目的结合，Quenya 能够提供一个完整的 REST API 开发和测试解决方案。