Init commit

README.md

@@ -0,0 +1,65 @@
+Aliyun OpenAPI Shell SDK
+--
+# 介绍
+
+这是一个非官方的阿里云 OpenAPI Shell SDK，目的是方便 Shell 脚本直接调用阿里云 OpenAPI，主要是实现了自动计算签名。
+
+虽然阿里云官方有 [AliyunCLI](https://github.com/aliyun/aliyun-cli)，可以方便的在 Shell 环境下调用阿里云 OpenAPI。不过某些 API (比如 SSL 证书) 它并不支持，所以我就想写一个可能是最好用的 Shell SDK。
+
+这个 SDK 理论上支持所有阿里云 RPC OpenAPI，RESTful OpenAPI 暂不支持，因为我暂时没用到，以后可能会考虑支持。
+
+# 依赖
+
+SDK 主要依赖于 `curl`, `openssl`, `python3`
+
+其中 `python3` 用于 `urlencode`，因为纯 Shell 实现的 `urlencode` 可用性较低，索性就直接调用 Python 实现，内部的 Python 代码不兼容 Python2，只能运行于 Python3。
+
+# 使用
+
+使用起来非常简单，只需要在你的 Shell 脚本顶部导出`AliAccessKeyId` 和 `AliAccessKeySecret` 环境变量，然后引用 `AliyunOpenAPI.sh` 即可。
+
+```bash
+#!/usr/bin/env bash
+# 务必使用 export 导出
+export AliAccessKeyId="<AliAccessKeyId>" # 此处替换为你的阿里云 AliAccessKeyId
+export AliAccessKeySecret="<AliAccessKeySecret>" # 此处替换为你的阿里云 AliAccessKeySecret
+
+. AliyunOpenAPI.sh
+
+# 自定义 GET 参数的键值顺序要一一对应，而且不能包含空格。
+# 自定义值支持自定义函数，如果你需要包含空格或者读取文件等操作，可以声明一个自定义函数，然后按照此格式填写：函数名()，就比如下面这样。
+# SDK 在处理值的时候会自动执行自定义函数，但是如果自定义函数不存在则会导致获取值失败。
+
+get_show_size() {
+    echo 50
+}
+
+# 自定义 GET 参数的键
+ali_custom_key=(
+    "CurrentPage"
+    "ShowSize"
+)
+# 自定义 GET 参数的值
+ali_custom_value=(
+    "1"
+    "get_show_size()"
+)
+# 获取阿里云 SSL 证书列表
+# aliapi_rpc 的函数签名如下
+# aliapi_rpc <host> <http_method> <api_version> <api_action> <api_custom_key[]> <api_custom_value[]>
+aliapi_rpc "cas.aliyuncs.com" "GET" "2018-07-13" "DescribeUserCertificateList" "${ali_custom_key[*]}" "${ali_custom_value[*]}"
+# 可以通过 $? 是否等于 0 来判断是否执行成功（HTTP CODE == 200）
+# 执行成功返回 JSON 格式的结果，执行失败返回 HTTP CODE 或 curl 的退出代码。
+if [[ $? -eq 0 ]]; then
+    # 执行成功
+else
+    # 执行失败
+fi
+
+```
+
+更多使用方法可以参考 `example` 下的示例
+
+如果你有好的示例，欢迎提交 [PR](https://github.com/Hill-98/aliyun-openapi-shell-sdk/pulls)
+
+如果你有问题 / BUG 要反馈，也欢迎提交 [Issue](https://github.com/Hill-98/aliyun-openapi-shell-sdk/issues)