README.md

aliyun-openapi

How does it work?

Essentially aliyun-openapi is DSL definition + code generator. It generate the code based on openapi-meta JSON files.

How to use this code?

Before everything, make sure you run rake codegen:generate_code to build generated code and test!

Step 1 : Configuration

You need to configure the openapi before using it.

Aliyun::Openapi.configure do |config|
  config.ssl_required = true
  config.access_key_id = YOU_KEY_ID
  config.access_key_secret = YOUR_KEY_SECRET
  config.region = 'cn-hangzhou'
end

Step 2 :

require necessary lib files

require 'aliyun/openapi/all'

if you want to call particular product, just go with

require 'aliyun/openapi/ecs'

Step 3 : Call API by DSL like this

Here is the example:

Aliyun::Openapi::Client.ecs(version:'2014-05-26').describe_regions do |response|
  p response
end

The basic calling name convention is :

Aliyun::Openapi::Client.[product](version: [version]).[api_end_point]([param_key]: [param_value] ...) do |resposne|
# response is a Faraday response object
end