in-house-swagger / in-house-swagger

in-house swagger-tools server

Home Page:https://in-house-swagger.github.io/in-house-swagger/index.html

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

構築、設定変更をシンプルにしたい

suwa-sh opened this issue · comments

ストーリー

利用者 として
利用開始時に何をしているのかを把握 するために、
シンプルな手順で設定 できる。

背景・経緯

ドキュメントを用意しようとしたが、意図がわかりにくい手順が必要なので
シンプルになるように整理したい。

対応詳細

  1. spec-mgr起動ポート
    spec-mgr側はin-house-swagger +1
    editorがデフォルトでつなぐ先が渡せないので。

    1. spec-mgr

      • ポートの指定を、環境変数優先に変更
      • application.yamlのcontextPathを環境変数指定に変更
      • 環境変数側はデフォルトで空文字
    2. editor
      接続先spec-mgrのデフォルトを
      自IP:自ポート + 1 に変更

    let defaultSpecMgrHostname = window.location.hostname
    let defaultSpecMgrPort = eval(window.location.port) + 1
    curSpecMgr: "http://" + 
        defaultSpecMgrHostname + ":" + 
        defaultSpecMgrPort
    1. in-house-swagger
      spec-mgr起動ポートを 自ポート + 1 に設定して起動
    SPECMGR_PORT=$((${SERVER_PORT} + 1))
  2. Jettyインストール
    jettyのインストール時に
    jetty/etc/jetty.conf に console-capture.xml の指定を追加
    ※これをやっておかないとwebappのログが出ない。。。

  3. generatorをwar展開インストールに変更
    ログレベルの変更など設定変更できるようにしておきたい。

  4. bin/server start

    • spec-mgrの起動時にport表示
    • 起動順 を spec-mgr -> jetty に変更
    • jar形式 custom generator jarをシンボリックリンクでgenerator/WEB-INF/lib に同期
  5. インストール手順
    spec-mgrのインストール時にデフォルトユーザを作成しているが
    git remote repoを利用する場合は、削除 & 再作成が必要。
    ※git remote repoありの場合、意味の分からない手順。。。

    1. spec-mgr
      • デフォルトユーザ作成・削除をコマンドで実装
        →bin/git/clone.sh がユーザ追加相当なので、forceオプションの追加で再作成に対応。
    2. in-house-swagger
      • bin/install デフォルトユーザ追加を廃止
  • 手順イメージ
    • install

      1. bin/install
      2. (module/swagger-spec-mgr/config 変更)
      3. module/swagger-spec-mgr/bin/git/clone.sh
        → bin/server start の時には使える状態が整っている
    • server control

      • start
      • stop
      • restart
    • generate

      • template指定なし
        editorから
      • template指定あり
        cliから
      • groovy custom generator
        cliから