Rate My OpenAPI 使用教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01066/article/details/147360446

Rate My OpenAPI 使用教程

rate-my-openapi 项目地址: https://gitcode.com/gh_mirrors/ra/rate-my-openapi

1. 项目介绍

Rate My OpenAPI 是一个开源项目，旨在帮助开发者评估和提升他们的 OpenAPI 文档质量。它通过一套工具，包括网站、命令行工具、GitHub Action 和 API，来确保 API 设计和实现达到高标准的质量和可用性。该项目可以根据四个关键类别对 OpenAPI 定义文件进行评估并给出综合评分：文档、SDK 生成、安全性和完整性。

2. 项目快速启动

环境准备

在开始之前，确保您的系统中已经安装了 Node.js。

克隆项目

git clone https://github.com/zuplo/rate-my-openapi.git
cd rate-my-openapi

安装依赖

npm install

运行 CLI 工具

安装 CLI 工具之后，您可以使用以下命令对您的 OpenAPI 文件进行检测：

npm run lint --filename <您的OpenAPI文件路径> --api-key <您的API密钥>

请注意，您需要先在 Rate My OpenAPI官网注册以获取 API 密钥。

3. 应用案例和最佳实践

使用网站进行评估

访问 Rate My OpenAPI网站。
上传您的 OpenAPI 定义文件。
网站会给出详细的评分和改进建议。

集成到 CI/CD 流程

通过 CLI 工具，您可以轻松地将 OpenAPI 文档质量检查集成到您的持续集成/持续部署（CI/CD）流程中，确保每次提交都会进行质量检查。

GitHub Action 使用

在您的 GitHub 仓库中添加一个 .github/workflows 文件夹（如果尚不存在）。
创建一个新的 YAML 文件来定义工作流程，如下所示：

name: Rate My OpenAPI

on:
  pull_request:
    types: [opened, synchronize]
  push:

jobs:
  lint-openapi:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - uses: zuplo/rmoa-action@v1
      with:
        filepath: './path/to/your/openapi.json'
        apikey: '${{ secrets.RMOA_API_KEY }}'

确保您在仓库的 Secrets 中设置了 RMOA_API_KEY。