フロントエンドとバックエンドの分離開発ツール YAPI の導入実績

前にフロントエンドとバックエンドで開発モデルを分けて開発すると言っていたのですが、卒業したばかりなのでこの仕様の策定は私が担当しました｡卒業したばかりで大きな工場に行ったことがないので挑戦です｡オンラインプログラムが設定されています。Googleと githubで多くのプロジェクトを検索し、最終的に良いツールを見つけました . イントラネット上に構築されている限り、フロントエンドとバックエンドの個別開発のいくつかの欠点を完全に解決できます. 以下でビルドします

1. Yapiデータベース mongoを構築する

docker コマンドを直接起動して起動する

docker run -d \
  -p 27017:27017 \
  --name mongo \
  --restart=always \
  -v /data/mongo:/data/db \
  -e MONGO_INITDB_ROOT_USERNAME=mongo \
  -e MONGO_INITDB_ROOT_PASSWORD=123456 \
  mongo

2. カスタム構成ファイル yapi-config.json

mkdir /data/yapi
vim /data/yapi/yapi-config.json

構成を入力します (アカウントのパスワードを自分で変更します)

{
    
    
  "port": "3000",
  "adminAccount": "[email protected]",
  "timeout": 120000,
  "db": {
    
    
    "servername": "mongo",
    "DATABASE": "yapi",
    "port": 27017,
    "user": "mongo",
    "pass": "123456",
    "authSource": "admin"
  }
}

3. YAPIデータベースのインデックスと管理者アカウントを初期化する

docker run -it --rm \
  --link mongo:mongo \
  --entrypoint npm \
  --workdir /yapi/vendors \
  -v /data/yapi/yapi-config.json:/yapi/config.json \
  registry.cn-hangzhou.aliyuncs.com/anoyi/yapi \
  run install-server

パスワードを記録する

4. Yapi サービスを開始する

docker run -d \
  --name yapi \
  --restart=always \
  --link mongo:mongo \
  --workdir /yapi/vendors \
  -p 9999:3000 \
  -v /data/yapi/yapi-config.json:/yapi/config.json \
  registry.cn-hangzhou.aliyuncs.com/anoyi/yapi \
  server/app.js

5. ip:9999 にアクセスしてログインし、表示します

6. 新規プロジェクト、インターフェーステスト

jsonを見つけて貼り付けて保存するだけです

json を自動的に生成し、モックをクリックして表示します

7. まとめ

このツールは、基本的な json をシミュレートするのにより適しています. 利点: さまざまな json を貼り付けて対応する形式を生成できます, エクスポートとインポートをサポートし、多くのプラグインをサポートします. github ドキュメントで確認できます.サポートされているプラグインは.かなり完全です。短所：中国語、時間など、シミュレーションの内容を手動で変更する必要があります。

YApi ビジュアルインターフェイス管理プラットフォーム

体験アドレス：

http://yapi.smart-xwork.cn/

ドキュメンテーション：

hellosean1025.github.io/yapi

プラットフォーム紹介

YApi は、開発者、製品、およびテスターに、より洗練されたインターフェイス管理サービスを提供するために設計された、効率的で使いやすく強力な API 管理プラットフォームです。開発者は簡単に API を作成、公開、維持することができます.また、YApi はユーザーに優れたインタラクティブな体験を提供します.開発者は、プラットフォームが提供するインターフェイスデータ書き込みツールと簡単なクリック操作を使用するだけで、インターフェイス管理を実現できます.

特性

Json5 と Mockjs に基づいて、インターフェイスによって返されるデータの構造とドキュメントを定義します。これにより、効率が数倍向上します。
フラットな権限設計により、大規模なエンタープライズレベルのプロジェクトの管理が保証されるだけでなく、使いやすさも保証されます。
郵便配達員に似たインターフェイスのデバッグ
自動テスト、Response でのアサーションのサポート
MockServer は、通常のランダムモックのサポートに加えて、設定されたリクエストフィルタリングルールに従って期待されるデータを返すモック期待関数も追加します。
postman、har、swagger データのインポートをサポート
無料でオープンソース、イントラネット展開、情報漏えいの心配なし

イントラネット展開

環境要件

nodejs（7.6+)
mongodb（2.6+）
ギット

インストール

私たちが提供する yapi-cli ツールを使用すると、YApi プラットフォームを非常に簡単にデプロイできます。yapi サーバーを実行してビジュアル展開プログラムを開始し、対応する構成を入力し、クリックして展開を開始すると、Web サイト全体の展開が完了します。デプロイが完了したら、プロンプトに従って node/{site path/server/app.js} を実行し、サーバーを起動します。ブラウザで指定の URL を開き、[ログイン] をクリックして、設定した管理者の電子メールアドレスを入力します。システムにログインするためのデフォルトのパスワードは ymfe.org です (デフォルトのパスワードはパーソナルセンターで変更できます)。

npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server

サービス管理

pm2 を使用して、サービスの管理と保守を容易にします。

npm install pm2 -g  //安装pm2
cd  {项目目录}
pm2 start "vendors/server/app.js" --name yapi //pm2管理yapi服务
pm2 info yapi //查看服务信息
pm2 stop yapi //停止服务
pm2 restart yapi //重启服务

アップグレード

プロジェクトバージョンのアップグレードは非常に簡単で、既存のプロジェクトデータには影響しません。vendors ディレクトリ内のソースコードファイルのみが同期されます。

cd  {项目目录}
yapi ls //查看版本号列表
yapi update //更新到最新版本
yapi update -v {Version} //更新到指定版本

チュートリアル

YApi プラグイン

yapi sso ログインプラグイン
yapi cas ログインプラグインwsfe 作
yapi gitlab 統合プラグイン
oauth2.0 ログイン
Rap プラットフォームデータのインポート
Dingding Dingding ロボットプッシュプラグイン
export-docx-dataデータ docx ドキュメントのエクスポート
interface-oauth-token は認証トークンを定期的に自動取得するプラグインです
import-swagger-customize は、指定された swagger インターフェイスをインポートします

コード生成

YApi docker デプロイメント (非公式)

YApi いくつかのツール

Api Generatorインターフェイスドキュメントは、プラグインを自動的に生成します (侵入ゼロ)
自動テストに使用できる mysql サービス http ツール
yapi プラグインへのワンクリックアップロードインターフェイスのアイデア
アイデアインターフェイスアップロードデバッグプラグイン easy-yapi
postgres sql サービスを実行する
SpringBoot は YApi の自動生成に依存しています
Yapi X はワンクリックでインターフェースドキュメントを生成し、yapi、rap2、elinker などにアップロードします (IDEA プラグイン)。

YApiの一部のクライアント

どこへ
シートリップ
Eロング
美団
バイドゥ
テンセント
アリババ
景東
今日の見出し
VipPay
Lianjia.com
速い労働者
コンビニビー
中上恵民
シーナ
VIPS
スズメバチの巣
コンパニオンフィッシュ
メグヴィー・テクノロジー

この記事はもともと " Chengge ブログ"によって作成され、CC 4.0 BY-SA 著作権契約に従います. 転載するには、元のソースリンクとこのステートメントを添付してください.
原文リンク：フロントエンドとバックエンドの分離開発ツール YAPI導入実績