本文将介绍如何使用npm包swaggerize-koa创建一个可扩展的基于koa框架的API，您将学到如何编写、部署和测试restful API。Swaggerize-koa是一种基于swagger 2.0的API开发工具，提供中间件用于解析swagger规范并创建可测试、自包含的API应用程序。
什么是Swagger？
Swagger是一种API设计、生成、文件的工具集。它使用JSON或YAML格式定义API，这使得API文档更加容易阅读和编写。Swagger除了定义API的结构，还提供了API测试及API交互式文档生成等功能。
什么是Koa？
Koa是一种基于Node.js平台的web开发框架，它由Express的创造者设计。Koa使用了ES6的generator方法，提供了更简洁、高效的异步环境，并已经在生产环境得到广泛应用。
swaggerize-koa使用教程
安装
我们要做的第一件事就是在您的Koa目录下安装swaggerize-koa及其依赖项。 npm 安装：
npm install swaggerize-koa
创建一个Swagger规范
在开始编写API之前，我们需要一个Swagger规范。您可以通过Swagger Editor或者手动编写来创建。
-- -------------------- ---- -------
-------- -----
-----
-------- -------
------ --- -------
----- --------------
--------- ---
--------
- ----
- -----
---------
- ----------------
---------
- ----------------
------
-------
---------------------------- -----
----
-------- ------
------------ ------------------------------------------------
----------
----
------------ --------
-------
----- -----
------
----- ------
-----------
-------
----- -------
--------
----- ------
---------
- ------
- -------以上示例中，我们定义了一个"/users"路由，还定义了路由的get方法及其接口信息。
创建 Koa 应用程序
我们需要新建一个基于Koa的应用程序并将swaggerize-koa中的中间件集成进该应用程序。
-- -------------------- ---- ------- ----- --- - --------------- ----- ---------- - -------------------------- ----- ---- - --------------------- ----- ------ - ---------------------- ----- ------------- - -------------------------- ----- ----------- - -------------------------- ----- --- - --- ------ ----- ------ - --- --------- ---------------------- ---------------- --------------------------------------- ------------------------ ------------------------- ---------------- -- -- - ---------------- ------ --------- -- ---- ------- ---
在以上实例中，我们引用了Koa、koa-bodyparser、koa2-cors、koa-router及swaggerize-koa等依赖包，之后通过调用const app = new Koa()新建了一个Koa应用程序实例，并声明了路由器实例，之后将全局路由询问交由swaggerize-koa驱动，并展示内容。
运行和测试
最后一步，运行Koa程序并使用浏览器访问我们刚刚创建的API程序。
node app.js
现在，您可以访问http://localhost:3000/api-docs获得交互式API文档。您也可以访问http://localhost:3000/v1/users获取所需API信息。
总结
在本文中，我们通过安装swaggerize-koa、创建Swagger规范、基于Koa创建应用程序和测试的方式，学习了如何创建一个可扩展、在浏览器上测试的、自包含的交互式restful API。swaggerize-koa提供了在使用Swagger规范开发API时的完整设计、测试和交互式文档功能。希望本文对您有所帮助，您也可以通过本文的示例代码快速上手。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005662d81e8991b448e20a1