简介

http://yapi.trechina.cn/group/1452

image.png

1.编写接口

1.POST接口示例(token验证)

  1. #!/bin/bash -xv
  2. #
  3. # SMARTCOOLER.MENU.CGI >> 画面メニューロード
  4. #
  5. # Written by lv.xuanxuan Date : 2020/05/06
  7. #環境変数設定
  8. export PATH=/home/SMART_TRIAL:/home/SMART:/usr/local/bin:${PATH}
  9. export LANG=ja_JP.UTF-8
  11. #ログディレクトリ定義
  12. logd=/home/trial/AP/LOG
  14. # 走行ログの記録
  15. echo   "${logd}/LOG.$(basename $0).$(date +%Y%m%d)_$(date +%H%M%S)_$$" &> /dev/null
  16. exec 2> ${logd}/LOG.$(basename $0).$(date +%Y%m%d)_$(date +%H%M%S)_$$
  17. #変数定義
  18. dir=/home/trial/AP/SMARTCOOLER
  19. tmp=/tmp/$$-$(basename $0).$(date +%Y%m%d%H%M%S)
  21. #LV4
  22. pompad=/home/trial/APDATA/SMARTCOOLER/POMPA
  23. #TBL
  24. tbld=/SC/TBL
  26. #業務TBL
  27. sctbld=${pompad}/TBL
  28. #cgid
  29. cgid=${dir}/CGI
  30. #json変換
  31. tojsond=${dir}/CGI/TOJSON
  33. # 起動時刻の記録
  34. echo "Content-type:text/html;charset=UTF-8"
  35. echo ""
  37. #设置不同的返回信息
  38. ERROR_EXIT(){
  39.   echo '{"retstatus":"-1","token":"_","statusname":"処理エラー"}'
  40.   exit 1
  41. }
  43. ERROR_PARA(){
  44.   echo '{"retstatus":"-2","token":"_","statusname":"パラメーターエラー"}'
  45.   exit 1
  46. }
  48. ERROR_TOKEN(){
  49.   echo '{"retstatus":"-3","token":"_","statusname":"TOKEN無効"}'
  50.   exit 1
  51. }
  53. #画面からデータ取得
  54. #获取POST请求的参数
  55. dd bs=${CONTENT_LENGTH} >${tmp}-parameter
  57. ###########################
  58. # 業務処理開始
  59. ###########################
  61. #判断参数是否错误
  62. #ユーザーID
  63. userid=$(cat ${tmp}-parameter | jq -r .uid)
  64. [ -z ${userid} ] && ERROR_PARA
  65. [ ${userid} == "_" ] && ERROR_PARA
  67. #token
  68. token=$(cat ${tmp}-parameter | jq -r .token)
  69. [ -z ${token} ] && ERROR_PARA
  70. [ ${token} == "_" ] && ERROR_PARA
  72. #判断token是否正确
  73. #共通tokenチェック
  74. shl=COMMON_TOKEN_CHECK
  75. ${cgid}/${shl} ${userid} ${token}           > ${tmp}-check
  76. [ $? -eq 0 ] || ERROR_TOKEN
  77. [ $(cat ${tmp}-check | selrow -e '$1=="success"' | rowc) -ne 1 ] && ERROR_TOKEN
  79. #メニュー情報取得
  80. echo ${userid}                                     |
  81. # 1.ユーザー
  82. hejoin -k2 - ${sctbld}/SMARTCOOL_ROLE_USER         |
  83. # 1.角色ID 2.ユーザー
  84. hejoin -k1 - ${sctbld}/SMARTCOOL_ROLE_MENU         |
  85. # 1.角色ID 2.メニューID 3.表示フラグ(1:表示可,0:表示不可) 4.利用フラグ(1:利用可,0:利用不可)
  86. selrow -e '$3==1'                                  |
  87. kuniq -k2@4                                        |
  88. # 1.メニューID 2.利用フラグ(1:利用可,0:利用不可)
  89. hijoin -k1 - ${sctbld}/SMARTCOOL_MENU_MST          |
  90. # 1.メニューID 2.利用フラグ(1:利用可,0:利用不可) 3.大項目ID 4.大項目名 5.中項目ID 6.中項目名 
  91. # 7.中表示名 8.大表示名
  92. awk '{print $1,$3,$4,$5,$6,$7,$8,$2}'              > ${tmp}-menulist
  93. # 1.メニューID 2.大項目ID 3.大項目名 4.中項目ID 5.中項目名 6.中表示名 7.大表示名 8.r/w/a
  94. [ $(errchk ${PIPESTATUS[@]}) -eq 0 ] || ERROR_EXIT
  96. #//////////////////////////
  97. # 結果JSONファイル変換
  98. #/////////////////////////
  100. shl=COMMON_JSONDATA_MENU.SHELL
  101. ${tojsond}/${shl} ${tmp}-menulist > ${tmp}-json
  102. [ $? -eq 0 ] || ERROR_EXIT
  104. cat ${tmp}-json
  106. ####################
  107. #終了処理
  108. ####################
  109. #一時ファイル削除
  110. rm -rf ${tmp}* &>/dev/null
  111. exit 0

2.GET接口示例(token验证)

  1. !/bin/bash -xv
  2. #
  3. # SMARTCOOLER.MENU.CGI >> 画面メニューロード
  4. #
  5. # Written by lv.xuanxuan Date : 2020/05/06
  7. #環境変数設定
  8. export PATH=/home/SMART_TRIAL:/home/SMART:/usr/local/bin:${PATH}
  9. export LANG=ja_JP.UTF-8
  11. #ログディレクトリ定義
  12. logd=/home/trial/AP/LOG
  14. # 走行ログの記録
  15. echo   "${logd}/LOG.$(basename $0).$(date +%Y%m%d)_$(date +%H%M%S)_$$" &> /dev/null
  16. exec 2> ${logd}/LOG.$(basename $0).$(date +%Y%m%d)_$(date +%H%M%S)_$$
  17. #変数定義
  18. dir=/home/trial/AP/SMARTCOOLER
  19. tmp=/tmp/$$-$(basename $0).$(date +%Y%m%d%H%M%S)
  21. #LV4
  22. pompad=/home/trial/APDATA/SMARTCOOLER/POMPA
  23. #TBL
  24. tbld=/SC/TBL
  26. #業務TBL
  27. sctbld=${pompad}/TBL
  28. #cgid
  29. cgid=${dir}/CGI
  30. #json変換
  31. tojsond=${dir}/CGI/TOJSON
  33. #设置不同的返回信息
  34. # 起動時刻の記録
  35. echo "Content-type:text/html;charset=UTF-8"
  36. echo ""
  38. ERROR_EXIT(){
  39.   echo '{"retstatus":"-1","token":"_","statusname":"処理エラー"}'
  40.   exit 1
  41. }
  43. ERROR_PARA(){
  44.   echo '{"retstatus":"-2","token":"_","statusname":"パラメーターエラー"}'
  45.   exit 1
  46. }
  48. ERROR_TOKEN(){
  49.   echo '{"retstatus":"-3","token":"_","statusname":"TOKEN無効"}'
  50.   exit 1
  51. }
  53. #画面からデータ取得
  54. #获取GET请求的参数
  55. dd bs=${CONTENT_LENGTH} >${tmp}-parameter
  56. echo ${QUERY_STRING}  |qsstr >$tmp-parameter
  57. ###########################
  58. # 業務処理開始
  59. ###########################
  61. #ユーザーID
  62. userid=$(readvalue -u uid ${tmp}-parameter)
  63. [ -z ${userid} ] && ERROR_PARA
  64. [ ${userid} == "_" ] && ERROR_PARA
  66. #token
  67. token=$(readvalue -u token ${tmp}-parameter)
  68. [ -z ${token} ] && ERROR_PARA
  69. [ ${token} == "_" ] && ERROR_PARA
  71. #共通tokenチェック
  72. shl=COMMON_TOKEN_CHECK
  73. ${cgid}/${shl} ${userid} ${token}           > ${tmp}-check
  74. [ $? -eq 0 ] || ERROR_TOKEN
  75. [ $(cat ${tmp}-check | selrow -e '$1=="success"' | rowc) -ne 1 ] && ERROR_TOKEN
  77. #メニュー情報取得
  78. echo ${userid}                                     |
  79. # 1.ユーザー
  80. hejoin -k2 - ${sctbld}/SMARTCOOL_ROLE_USER         |
  81. # 1.角色ID 2.ユーザー
  82. hejoin -k1 - ${sctbld}/SMARTCOOL_ROLE_MENU         |
  83. # 1.角色ID 2.メニューID 3.表示フラグ(1:表示可,0:表示不可) 4.利用フラグ(1:利用可,0:利用不可)
  84. selrow -e '$3==1'                                  |
  85. kuniq -k2@4                                        |
  86. # 1.メニューID 2.利用フラグ(1:利用可,0:利用不可)
  87. hijoin -k1 - ${sctbld}/SMARTCOOL_MENU_MST          |
  88. # 1.メニューID 2.利用フラグ(1:利用可,0:利用不可) 3.大項目ID 4.大項目名 5.中項目ID 6.中項目名 
  89. # 7.中表示名 8.大表示名
  90. awk '{print $1,$3,$4,$5,$6,$7,$8,$2}'              > ${tmp}-menulist
  91. # 1.メニューID 2.大項目ID 3.大項目名 4.中項目ID 5.中項目名 6.中表示名 7.大表示名 8.r/w/a
  92. [ $(errchk ${PIPESTATUS[@]}) -eq 0 ] || ERROR_EXIT
  94. #//////////////////////////
  95. # 結果JSONファイル変換
  96. #/////////////////////////
  98. shl=COMMON_JSONDATA_MENU.SHELL
  99. ${tojsond}/${shl} ${tmp}-menulist > ${tmp}-json
  100. [ $? -eq 0 ] || ERROR_EXI
  102. cat ${tmp}-json
  104. ####################
  105. #終了処理
  106. ####################
  107. #一時ファイル削除
  108. rm -rf ${tmp}* &>/dev/null
  109. exit 0

2.添加分组

image.png

3.添加项目

点击分组名-点击添加项目
image.png

image.png

3.项目环境配置

点击项目-设置-环境设置
设置完成点击保存
image.png

4.接口配置

添加接口

1.设置接口类型
2.设置接口名称和路径后点击保存
image.png

配置POST接口

点击接口-编辑进行接口配置

1.设置接口基本信息

image.png

2.设置接口需要的请求参数(默认使用form参数)

form参数示例

image.png

json参数示例

image.png

file参数示例
  1. {"type":"object","title":"empty object","properties":{"uid":{"type":"string","description":"用户名","mock":{"mock":"admin"}},"token":{"type":"string","description":"认证token信息","mock":{"mock":"d279ea03169dec0aaa5c05845fd9b461"}}},"required":["uid","token"]}

raw参数示例
  1. {"type":"object","title":"empty object","properties":{"uid":{"type":"string","description":"用户名","mock":{"mock":"admin"}},"token":{"type":"string","description":"认证token信息","mock":{"mock":"d279ea03169dec0aaa5c05845fd9b461"}}},"required":["uid","token"]}

3.返回数据设置

image.png

4.接口测试

image.png

配置GET接口

1.设置接口基本信息

image.png

2.设置接口需要的请求参数

image.png

3.返回数据设置

image.png

4.接口测试

image.png

问题一览

1.添加项目时的基本路径

此路径影响的是项目中的mock路径
image.png
image.png

2.接口copy

接口copy会自动添加后缀，其他不变
image.png

3.项目删除

在项目-设置中点击危险操作
image.png

4.tag设置

在项目-接口-编辑-tag中设置版本
image.png