用于apimatic的命令行接口。
apimatic-cli的Python项目详细描述
#Apimatic客户端
[![PYPI版本](https://badge.fury.io/py/apimatic cli.svg)(https://badge.fury.io/py/apimatic cli)
[![构建状态](https://travis-ci.org/apimatic/apimatic-cli.svg?branch=master)"(https://travis ci.org/apimatic/apimatic cli)
\支持以下函数:
*生成一个sdk
*验证一个api描述
*转换一个api描述
它也可以手动进行:
```
git clone https://github.com/apimatic/apimatic cli.git
cd apmiatic cli
python setup.py install
`````
```
如果您选择这样做,强烈建议使用[虚拟环境](http://docs.python-guide.org/en/latest/dev/virtualenvs/)。
确保您位于存储库的根文件夹中,然后键入:
```
python-m apimaticcli-h
```
要使用此工具,必须提供两个位置参数:
*命令(生成、验证或转换)
*身份验证类型(fromapikey、fromuser或fromauthkey)
或者可选参数,可以按如下方式键入-h:
````
apimatic cli generate from apikey-h
````
您将使用其中的一个子集,具体取决于您使用的位置参数。
```
-h或--help显示帮助文本并存在。
--api key从apimatic获取的api描述的api key。
--platform需要为其生成sdk的平台。它可以是其中之一:
cs_portable_net_lib、java_eclipse_jre_jre_lib、java_gradle_android_lib、
objc_cococoa_touch_ios_lib、angular_javascript_lib、ruby_generic_lib、
下载到下载文件的文件夹路径。
--命名生成的sdk的名称。
--用电子邮件发送用户apimatic帐户的电子邮件地址。
--用密码发送用户apimatic帐户的密码。
--auth key用户的apimatic帐户。
--url api描述的url。
--file api描述文件的路径。
--格式化要将api描述转换为的格式。它可以是:
apilubprint、swagger10、swagger20、swaggeryaml、wadl2009、raml、apimatic
--作为下载文件的名称(和扩展名)下载。
--如果使用此选项,则跳过下载的sdk的跳过解压缩。
````
使用api集成键创建c sdk:
```
apimatic cli generate from api key--api key<;your key>;--platform cs_portable_net懔lib--下载到./sdks
````
使用用户凭据和api描述文件生成python sdk并跳过解压缩:
````
apimatic cli generate from user--email<;your apimatic account email>;--password<;your apimatic account password>;--name testsdk--file./data/calculator.json--platform python_generic_lib--download to./sdks--skip unzip
`````
使用用户身份验证密钥生成ruby sdk以及一个api描述url,并将下载的sdk重命名为:
```
apimatic cli generate fromauthkey--auth key<;your apimatic account authentication key>;--name testsdk--url http://www.somewebsite.com/apidecription.json--platform ruby--generic--lib download to./sdks--download ascustomname
```
使用api集成密钥验证api描述:
````
apimatic cli validate fromapikey--api key<;your key>;
```
使用用户身份验证密钥和api描述文件验证api描述:
````
apimatic clivalidate fromauthkey--auth key<;您的apimatic帐户身份验证密钥>;--file./data/calculator.json
````
>使用用户凭据和api描述url验证api描述:
````
apimatic cli validate fromuser--email<;您的apimatic帐户电子邮件>;--密码<;您的apimatic帐户密码>;-url http://www.somewebsite.com/apidecription.json
```
rint
``
apimatic
```
使用用户身份验证密钥和api描述url将api描述转换为swagger v2.0(yaml)格式:
````
apimatic cli transform fromauthkey--auth key<;your apimatic account authentication key>;--url http://www.somewebsite.com/apidecription.json—格式扩展名
[![PYPI版本](https://badge.fury.io/py/apimatic cli.svg)(https://badge.fury.io/py/apimatic cli)
[![构建状态](https://travis-ci.org/apimatic/apimatic-cli.svg?branch=master)"(https://travis ci.org/apimatic/apimatic cli)
\支持以下函数:
*生成一个sdk
*验证一个api描述
*转换一个api描述
它也可以手动进行:
```
git clone https://github.com/apimatic/apimatic cli.git
cd apmiatic cli
python setup.py install
`````
```
如果您选择这样做,强烈建议使用[虚拟环境](http://docs.python-guide.org/en/latest/dev/virtualenvs/)。
确保您位于存储库的根文件夹中,然后键入:
```
python-m apimaticcli-h
```
要使用此工具,必须提供两个位置参数:
*命令(生成、验证或转换)
*身份验证类型(fromapikey、fromuser或fromauthkey)
或者可选参数,可以按如下方式键入-h:
````
apimatic cli generate from apikey-h
````
您将使用其中的一个子集,具体取决于您使用的位置参数。
```
-h或--help显示帮助文本并存在。
--api key从apimatic获取的api描述的api key。
--platform需要为其生成sdk的平台。它可以是其中之一:
cs_portable_net_lib、java_eclipse_jre_jre_lib、java_gradle_android_lib、
objc_cococoa_touch_ios_lib、angular_javascript_lib、ruby_generic_lib、
下载到下载文件的文件夹路径。
--命名生成的sdk的名称。
--用电子邮件发送用户apimatic帐户的电子邮件地址。
--用密码发送用户apimatic帐户的密码。
--auth key用户的apimatic帐户。
--url api描述的url。
--file api描述文件的路径。
--格式化要将api描述转换为的格式。它可以是:
apilubprint、swagger10、swagger20、swaggeryaml、wadl2009、raml、apimatic
--作为下载文件的名称(和扩展名)下载。
--如果使用此选项,则跳过下载的sdk的跳过解压缩。
````
使用api集成键创建c sdk:
```
apimatic cli generate from api key--api key<;your key>;--platform cs_portable_net懔lib--下载到./sdks
````
使用用户凭据和api描述文件生成python sdk并跳过解压缩:
````
apimatic cli generate from user--email<;your apimatic account email>;--password<;your apimatic account password>;--name testsdk--file./data/calculator.json--platform python_generic_lib--download to./sdks--skip unzip
`````
使用用户身份验证密钥生成ruby sdk以及一个api描述url,并将下载的sdk重命名为:
```
apimatic cli generate fromauthkey--auth key<;your apimatic account authentication key>;--name testsdk--url http://www.somewebsite.com/apidecription.json--platform ruby--generic--lib download to./sdks--download ascustomname
```
使用api集成密钥验证api描述:
````
apimatic cli validate fromapikey--api key<;your key>;
```
使用用户身份验证密钥和api描述文件验证api描述:
````
apimatic clivalidate fromauthkey--auth key<;您的apimatic帐户身份验证密钥>;--file./data/calculator.json
````
>使用用户凭据和api描述url验证api描述:
````
apimatic cli validate fromuser--email<;您的apimatic帐户电子邮件>;--密码<;您的apimatic帐户密码>;-url http://www.somewebsite.com/apidecription.json
```
rint
``
apimatic
```
使用用户身份验证密钥和api描述url将api描述转换为swagger v2.0(yaml)格式:
````
apimatic cli transform fromauthkey--auth key<;your apimatic account authentication key>;--url http://www.somewebsite.com/apidecription.json—格式扩展名