yapiインタフェース管理プラットフォームオフラインインストール記録

4244 ワード

YApiは、開発、製品、テスト担当者により優雅なインタフェース管理サービスを提供することを目的としています.開発者がAPIの作成、パブリッシュ、メンテナンスを容易にする
---公式説明文書yapi公式サイトより抜粋
仕事の中でよくインタフェースの機能をテストする必要があります.開発者は参考になるインタフェースのドキュメントを提供していないので、fiddler、postman、Jmeterの多くのツールを混用してインタフェースをテストします.何気なくこのYApiのプラットフォームを見つけたのですが、やはりオープンソース無料なので、サーバーで試してみました.この文書では、Yapiのイントラネット導入方法について説明します.

付属ソフトウェア


nodejs v10.15.3    https://nodejs.org/en/download/
mongodb v4.0.6    https://www.mongodb.com/download-center/community
centos6.10 64bit

環境構築


nodejsのインストールここでは、/usr/local/binディレクトリにソフトリンクを追加するのに便利な環境変数がありません.
tar xvf node-v10.15.3-linux-x64.tar.xz   ls
cd node-v10.15.3-linux-x64
mv node-v10.15.3-linux-x64 nodejs
ln -s /root/nodejs/bin/npm /usr/local/bin
ln -s /root/nodejs/bin/node /usr/local/bin

Node-v npmコマンドが使えばいい
mongodbのインストール
mkdir mongodb
tar zxvf mongodb-linux-x86_64-4.0.6.tgz -C mongodb
mv mongodb-linux-x86_64-4.0.6/ /usr/local/mongodb
vi /etc/profile
#  mongodb 
export PATH=$PATH:/usr/local/mongodb/bin
source /etc/profile

2.mongo--versionで使用可能な出力バージョン情報を確認する
3.mongodbを構成する.cnfプロファイル情報
#    
dbpath=/data/mongo/
#  
logpath=/data/mongo/mongo.log   
#      
logappend=true 
#  
fork=true
#  
port=27017


4. mongod -f/usr/local/mongodb/mongdb.cnfがmongodbserverを起動正常にmongodbが起動しました
5.mongoコマンドでネイティブのmongodbに接続できるデフォルトではユーザー名パスワードが登録されていません
現在のすべてのデータベースをshow dbsコマンドで表示できます.
6.ユーザー名/パスワードの作成
> use admin
switched to db admin
> db.createUser(
...   {
...     user: "root",
...     pwd: "password",
...     roles: [ { role: "userAdminAnyDatabase", db: "admin" } ]
...   }
... )
Successfully added user: {
    "user" : "root",
    "roles" : [
        {
            "role" : "userAdminAnyDatabase",
            "db" : "admin"
        }
    ]
}

最後のステップyapiインストール


外部ネットワーク側でyapiソースをダウンロードする(パッケージ依存node.js環境)
mkdir yapi
cd yapi
git clone https://github.com/YMFE/yapi.git vendors
cp vendors/config_example.json ./config.json
cd vendors
npm install --production

yapi全体をzip圧縮パッケージにパッケージしてサーバにインポート
unzip解凍
configを修正する.jsonファイルのmongodbの構成、アクセスポートのデフォルト3000
[root@k8s-db test]# cat config.json 
{
  "port": "3000",
  "adminAccount": "[email protected]",
  "db": {
    "servername": "127.0.0.1",   
    "DATABASE": "yapi",
    "port": 27017,
    "user": "root",
    "pass": "password",
    "authSource": "admin"
  },

データベースの初期化(mongodbが実行され、adminユーザー名/パスワードが構成されていることを確認します)
cd ./yapi/vendors
npm run install-server

初期化完了のプロンプト
[root@k8s-db vendors]# npm run install-server

> [email protected] install-server /root/test/vendors
>  node server/install.js

log: mongodb load success...
 , :"[email protected]", :"ymfe.org"

vendorsディレクトリでnode server/appを実行する.js起動yapi server通常の状況で表示
 
[root@k8s-db vendors]# node server/app.js 
log:  , : 
http://127.0.0.1:3000/
log: mongodb load success...

ブラウザを開いてip:3000にアクセスするとyapiインタフェース管理プラットフォームが使用できます
デフォルトの管理者は[email protected]パスワードorgのデフォルト登録もオープンです..
ldap方式認証ログインを構成して登録を閉じ、公式説明ドキュメントを参照することもできます.

補足


node起動方式は端末フロントでしか実行できないことが判明し、xshell sshがタイムアウトした後、プロセスが停止します.の
pm 2のプロセス管理方式に変更
  • ネットワーク接続可能な機器上npm install pm 2-g
  • nodeのグローバルnodeをパッケージ化modulesディレクトリのpm 2パケットがサーバnodeインストールパス/node_に転送されます.modulesディレクトリ下
  • ln-s ln-sソフトリンクを作成ln-s/root/node_modules/pm2/bin/pm2 /usr/local/bin/pm2
  • コマンドライン実行pm 2正常出力は
  • が使用可能であることを示す.
  • pm2 start  app.js起動アプリケーション
  • pm 2について


    https://www.npmjs.com/package/pm2公式サイト
    https://github.com/Unitech/PM2/プロジェクトパス
     
    使用体験:インタフェースを便利に管理することができて、多種のmockデータの方法を提供して、インタフェースフィールドの入出力を明確にする情況の下で、フロントエンドの同級生のmockインタフェースのデバッグを便利にすることができて、開発を加速します.テスト同級生にとって、インタフェースの自動化の補助手段としても使用できます.postmanインタフェースのインポートもサポートされており、インタフェースドキュメントのさまざまなフォーマットのエクスポートもサポートされています.