npm 包 fury.cli 使用教程

在前端开发中,我们常常需要使用一些 npm 包来帮忙完成一些工作,比如搭建开发环境、进行模块化管理等等。今天介绍的 npm 包 fury.cli 可以帮助我们更便捷地管理 API 文档,提高开发效率。

什么是 fury.cli

fury.cli 是一个命令行工具,可以通过命令行对 API 文档进行操作和管理。它可以将 API 文档转换成多种格式,如 OpenAPI、RAML、Swagger、API Blueprint 等。同时,它还能够将这些格式的 API 文档进行合并、分割、校验等操作。

fury.cli 使用 TypeScript 编写,适应于多种环境,包括命令行、Node.js、浏览器等。它的功能强大、易于使用,是一个非常优秀的 API 文档工具。

fury.cli 的安装

安装 fury.cli 非常简单,只需要在命令行中输入以下命令即可:

--- ------- -- ----

这个命令会全局安装 fury.cli,也就是说,你可以在任何目录下使用 fury 命令来操作 API 文档。如果你希望将 fury.cli 安装到本地项目中,可以使用以下命令:

--- ------- ----

fury.cli 的基本使用

fury.cli 支持许多命令,这里我们介绍一些常见的命令。

解析 API 文档

如果你已经有了一个 API 文档文件,并且知道它的类型,那么可以使用以下命令将其解析成对应的 JSON 格式:

---- ----- -- ------- -- -------------------- -- --------------------

这个命令将会将 path/to/swagger.yaml 文件解析成 Swagger 格式,并将解析结果输出到 path/to/swagger.json 文件中。

转换 API 文档格式

fury.cli 支持将多种格式的 API 文档转换成其他格式。例如,如果你有一个 Swagger 格式的 API 文档,并且希望将其转换成 OpenAPI 格式,可以使用以下命令:

---- --------- -- ------- -- -------------------- -- ------- -- --------------------

这个命令将会将 path/to/swagger.yaml 文件转换成 OpenAPI 格式,并将转换结果输出到 path/to/openapi.json 文件中。

合并多个 API 文档

如果你有多个 API 文档文件,并且希望将它们合并成一个文件,可以使用以下命令:

---- ----- -- ----------------------------------------------------------------- -- ------------------------

这个命令将会将 path/to/swagger1.yamlpath/to/swagger2.yamlpath/to/swagger3.yaml 三个文件合并成一个 Swagger 格式的文件,并将合并结果输出到 path/to/all-swagger.json 文件中。

分割 API 文档

如果你有一个很大的 API 文档文件,并且希望将其分割成多个文件,可以使用以下命令:

---- ----- -- ------- -- -------------------- -- ------------------------ -- ---

这个命令将会将 path/to/swagger.yaml 文件分割成若干个大小不超过 100 KB 的文件,并将分割结果输出到 path/to/output/directory 目录中。

总结

fury.cli 是一个非常优秀的 API 文档工具,它可以方便地管理 API 文档,提高开发效率。本文介绍了 fury.cli 的基本使用方法,希望对大家有所帮助。如果你想了解更多关于 fury.cli 的信息,可以查看它的官方文档:https://fury.io/cli/。

示例代码:

-- --- -------- -------------------- --- ------- --
----- -- - --------------
----- ---- - ----------------
----- ---- - ----------------

------------------------------------------

----- -------- - -------------------- ------------------------
----- ------------- - -------------------------------------

----- --------- - --- -------
------------------------ -------------- ---------- ------------------------------ ----- -------
    -------------- -------- -
        -------------------------------------------------- ----- ----
    -- -------- ------- -
        -------------------
    ---

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60055ffb81e8991b448ddcb5


猜你喜欢

  • npm包react-big-calendar-fix283使用教程

    前言 在前端开发中,我们经常需要使用到日历组件,在这方面React提供了一个很好的解决方案——react-big-calendar。但是,这个npm包并不完美,有一些已知的bug没有被修复,从而影响了...

    3 年前
  • npm 包 ujumbesms 使用教程

    简介 ujumbesms 是一个基于 Node.js 开发的 npm 包,可以方便地在前端应用中发送短信。 安装 使用 npm 安装 ujumbesms: --- ------- ---------使...

    3 年前
  • npm 包 snicksnack 使用教程

    前言 随着前端技术日新月异的发展,我们在开发中越来越多地使用npm包。npm包是一种方便易用的Javascript组件。在这篇文章中,我将会分享一款我使用过的npm包——snicksnack,并向大家...

    3 年前
  • npm 包 jshark 使用教程

    什么是 jshark jshark 是一个基于 JavaScript 的网络数据包解析库,它可以将网络数据包进行解析并转换成一个可读的数据结构。jshark 支持多种网络协议,包括但不限于 HTTP、...

    3 年前
  • npm 包 xuanleilei_censorify 使用教程

    前言 随着互联网的飞速发展,我们在日常的使用中难免会遇到一些敏感词汇,因为这些词汇可能会引起一些不必要的争议和误会。那么如何避免敏感词汇的出现呢?这里就为大家介绍一款 npm 包——xuanleile...

    3 年前
  • npm 包 focha 使用教程

    前言 在前端开发中,我们经常需要编写测试代码来确保程序的正确性和健壮性。但是手动编写测试也很容易出错,而且比较繁琐。这时候,我们可以借助测试框架来简化这个过程。 今天介绍的是一个 Node.js 的测...

    3 年前
  • npm 包 node-red-contrib-blynk-bridge 使用教程

    前言 在前端开发过程中,我们经常会使用到各种 npm 包来解决开发问题,其中 node-red-contrib-blynk-bridge 就是一个非常实用的 npm 包,它可以用来搭建 IoT 物联网...

    3 年前
  • serverless-logstreaming npm 包使用教程

    简介 serverless-logstreaming 是一个 npm 包,可以快速将云端函数的日志数据流式传输到云日志服务,方便用户进行日志查看和监控。本文将介绍该 npm 包的安装和使用方法。

    3 年前
  • npm 包 maybabel 使用教程

    Maybabel 是一个极其轻量级但功能强大的 npm 包,它提供了为我们的项目编写 CSS 样式的工具。本文将详细介绍 maybabel 的功能和使用方法,并附带实用示例代码。

    3 年前
  • npm 包 ng-window-scope-size 使用教程

    简介 ng-window-scope-size 是一个 AngularJS 模块,用于获取浏览器窗口的大小,并将其传递给指定的作用域变量。使用 ng-window-scope-size,您可以轻松地在...

    3 年前
  • npm 包 esdoc-member-plugin 使用教程

    简介 esdoc-member-plugin 是 ESDoc 的一个插件,可以用于生成 JavaScript 文档。该插件可以帮助开发者自动生成文档的成员列表,实现文档的有效管理和维护。

    3 年前
  • npm 包 json-sql-isme2n 使用教程

    前言 作为前端开发人员,我们经常需要与数据库打交道。在这个过程中,SQL(Structured Query Language)是我们必不可少的工具。SQL 是一种用于操作关系数据库的语言,它支持增删改...

    3 年前
  • npm 包 generator-zweman 使用教程

    在前端开发过程中,我们经常需要编写重复性的代码,比如新建一个项目的初始代码,或者新建一个组件的基本结构代码。为了提高开发效率,在使用 Yeoman 来构建项目时,可以选择 generator-zwem...

    3 年前
  • npm 包 react-native-round-flags 使用教程

    简介 react-native-round-flags 是一款基于 React Native 开发的轻量级组件库,用于快速创建圆形国家/地区标识。它可以帮助开发者以极简单且美观的方式添加国旗或地区标识...

    3 年前
  • npm 包 chaldeas 使用教程

    简介 在前端开发中,很多时候我们需要对时间进行转换、计算,这时就需要用到一个好用的时间库。chaldeas 是基于 momentjs 的时间库,然而 chaldeas 比 momentjs 更加灵活,...

    3 年前
  • npm 包 clubspeedscraper 使用教程

    简介 clubspeedscraper 是一个用于在 node.js 中爬取 Clubspped 站点数据的 npm 包。你可以使用它来获取每个比赛的分数表格以及每个司机的详细信息。

    3 年前
  • npm 包 fis3-postpackager-h5cachejson 使用教程

    前言:随着移动互联网的发展,移动端 H5 页面越来越受到关注和重视,因此 H5 页面的性能和体验也逐渐成为了一个热点话题。其中,H5 页面缓存是提升页面性能和体验的重要手段之一。

    3 年前
  • npm 包 ofx-js 使用教程

    在前端开发中,经常需要处理金融数据。而 OFX(Open Financial Exchange)是一种金融数据交换格式,通常用于进行电子银行间的数据交换。ofx-js 是一个能够解析 OFX 数据格式...

    3 年前
  • npm 包 react-native-app-shortcuts 使用教程

    1. 简介 react-native-app-shortcuts 是一个基于 React Native 开发的快捷应用程序快捷键插件。该插件让用户可以在快捷方式菜单中添加自定义项目,方便快速进入APP...

    3 年前
  • NPM 包 libsteroids-assets 使用教程

    简介 在前端开发中,经常需要使用一些图标库、字体库等资源,这时可以使用 libsteroids-assets 这个 NPM 包来管理这些资源,极大的简化了资源引入和管理的过程。

    3 年前

相关推荐

    暂无文章