npm 包 zally-web-ui 使用教程

简介

zally-web-ui 是一个基于 Zalando Zally 的 Web 界面，它可以让你通过 Web 界面来对上述 API 文档进行自动化 API 设计分析。

安装

要使用 zally-web-ui，你需要先安装 Node.js。然后，你可以使用 npm 包管理器来安装它：

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

使用

启动服务

安装完成后，在项目的根目录下运行以下命令（其中 $PORT 是你自己指定的端口号）：

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

此命令会下载 Zalando Zally 的规则集并启动 Web 界面服务。

发送请求

启动服务后，你可以通过表单提交 API 文档并获取分析结果。POST 请求会被发送到 http://localhost:$PORT/api/violations。

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

API 文档可以是 OpenAPI 或 Swagger 格式的 JSON 或 YAML 文件。例如，下面是一个示例 JSON 文件：

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

高级用法

自定义规则集

zally-web-ui 默认使用 Zalando Zally 的默认规则集 进行分析，但你也可以使用自定义的规则集。要指定自定义规则集，请使用 --rules 参数：

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

自定义规则集的格式需要满足 Zalando Zally 规则集格式。

部署到服务器

如果你想将 zally-web-ui 部署到服务器上，我们推荐使用 PM2 来管理和监控服务。

首先，全局安装 PM2：

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

然后，在项目根目录运行以下命令：

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

总结

通过本篇文章，你已经了解了如何使用 npm 包 zally-web-ui 进行自动化 API 设计分析，并掌握了 zally-web-ui 的高级用法。希望这对于你在前端开发中提高 API 设计水平和减少工作量有所帮助。

感谢您的阅读！

示例代码

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/6005607981e8991b448dea7c

阅读全文

猜你喜欢

  • npm 包 @gserrg/vue-material 使用教程

    前言 @gserrg/vue-material 是一个基于 Vue.js 的 UI 组件库，提供了大量的 Material Design 风格的组件和样式。该库可以方便地集成到 Vue.js 项目中，...

    3 年前
  • npm 包 jfe 使用教程

    前言 随着前端技术的快速发展和升级，越来越多的 npm 包被开发出来，用于解决前端开发中的各种问题。其中，jfe 是一款非常优秀的 npm 包，可以帮助前端开发者快速开发高质量的项目。

    3 年前
  • npm 包 ngx-leaflet-fa-markers 使用教程

    npm 包 ngx-leaflet-fa-markers 使用教程 前言 在前端开发中，地图成为了不可或缺的一个模块，但是在开发中，我们往往需要更加多样化的地图标记样式，而只用系统默认的标记往往难以满...

    3 年前
  • npm 包 tboc-calendar 使用教程

    前言 在前端开发中，很多时候需要使用到日历控件。tboc-calendar 是一个非常实用的 npm 包，它提供了简单易用的日历组件。在本篇文章中，我们将介绍如何使用 tboc-calendar，并且...

    3 年前
  • npm 包 tboc-button 使用教程

    1. 简介 tboc-button 是一个轻量级的 npm 包，用于快速生成网页中的基础按钮。它内置了多种样式，让网页制作更加简单快捷。本文将介绍如何在项目中使用 tboc-button。

    3 年前
  • npm 包 tboc-gotop 使用教程

    介绍 tboc-gotop 是一个简单易用的轻量级 jQuery 插件库，帮助 web 开发者快速添加返回顶部按钮。该插件支持自定义按钮样式，设置触发的滚动距离等。

    3 年前
  • npm 包 uon.anim 使用教程

    1. 什么是 uon.anim？ uon.anim 是一个针对前端动画设计的 npm 包，它帮助你设计出更多样化、更生动的动画效果，在页面的互动体验上起到了至关重要的作用。

    3 年前
  • npm 包 value-looker 使用教程

    前言 在前端开发过程中，我们经常会面临需要查找对象属性值的问题，而这个问题通常可以通过编写一些辅助函数来实现。但是，这样的辅助函数并不一定通用，且需要不断地修改和维护，增加了代码的复杂度，也浪费了大量...

    3 年前
  • npm 包 react-native-vertical-alphabet 使用教程

    在 React Native 开发中，垂直排列的字母表展示是一个常见的需求。而 react-native-vertical-alphabet 则是一个帮助我们快速实现该需求的 npm 包。

    3 年前
  • npm 包 @bitliner/wonderdoc 使用教程

    在前端开发过程中，我们常常需要生成 API 文档、组件库文档等等。在这些情况下，手动编写文档是很费事的，使用自动化工具则能够大大提高效率。今天，我们要介绍一个 npm 包：@bitliner/wond...

    3 年前
  • npm包rsjf-rui-123456使用教程

    介绍 rsjf-rui-123456是一款前端开发中的npm包，提供了多种实用性的功能，主要包括表单校验等，能够便利地帮助开发者提高开发效率。 安装 使用npm安装rsjf-rui-123456： -...

    3 年前
  • npm 包 ng2-simple-modal 使用教程

    ng2-simple-modal 是一个 Angular 2 模态框组件的 npm 包，它提供了基本的模态框功能，如弹出框，确认框，提示框等等。下面是一个详细的使用教程，包括了安装，组件属性，使用示例...

    3 年前
  • npm 包 publish-demo-5991 使用教程

    前言 npm 是 Node.js 中非常重要的包管理工具，它极大地方便了前端开发者对各种依赖包的管理和使用。而本文将介绍一个名为 publish-demo-5991 的 npm 包的使用教程。

    3 年前
  • npm 包 grunt-files-list2 使用教程

    介绍 在前端开发中，使用 grunt 是一种常见的自动化构建工具。而 grunt-files-list2 则是一个非常有用的 npm 包，它可以帮助我们自动生成文件列表，从而实现对文件进行批量操作等功...

    3 年前
  • npm 包 curl-download-windows 使用教程

    简介 npm 包 curl-download-windows 是一个可以在 Windows 系统上使用 curl 命令下载文件的工具。 它是基于 Node.js 开发的一个命令行工具，可以方便地在 W...

    3 年前
  • npm 包 react-iso 使用教程

    在 Web 开发中，前端技术日新月异。React 是当下前端最为流行的框架之一，而利用 React 编写同构（Isomorphic）应用在前端领域也变得越来越流行。

    3 年前
  • npm 包 l10n-async 使用教程

    简介 在前端开发中，国际化（i18n）和本地化（l10n）一直是一个重要的问题。l10n-async 是一个 npm 包，它提供了一种异步的本地化方案，可以在前端应用中非常方便地实现本地化语言的切换。

    3 年前
  • npm 包 eslint-config-feng 使用教程

    前言 eslint 是一个非常流行的 JavaScript 静态代码检查工具，能够帮助开发者在编写代码的过程中避免一些常见的错误和不规范的写法。eslint 可以配置规则，让其根据不同的项目需求来自定...

    3 年前
  • npm 包 transcend-spotify-react 使用教程

    在现代网站开发中，使用第三方库和框架可以显著提高开发效率和功能丰富程度。而 npm 是一个非常流行的包管理器，网站开发者可以在其中寻找数以万计的开源项目来完成他们的代码需求。

    3 年前
  • npm 包 transcend-spotify-columns-react 使用教程

    如果你正在开发一个前端应用，特别是一个音乐相关应用，你可能会需要使用 Spotify API 来获取音乐数据。而 npm 包 transcend-spotify-columns-react 则是一个可...

    3 年前

相关推荐

    暂无文章