2.0 KiB

Исходник Постоянная ссылка Ответственный История

Creating JSON-RPC server

The Azure SDK Live Test Framework uses JSON-RPC to call Azure SDK functions.

1. JSON-RPC

JSON-RPC for Swagger is based on

2. Swagger JSON-RPC Mapping

2.1. Operation Mapping

Swagger Title	Swagger Operation Id	JSON-RPC method
`A`	`B_C`	`A.B_C`

2.2. Reserved Parameters

An additional parameter __reserved is added to each JSON-RPC call.

For example

{
    "jsonrpc": "2.0",
    "method": "A.B_C",
    "id": "0",
    "params": {
        "__reserved": {
            "credentials": {
                "tenantId": "...active directory tenant id...",
                "clientId": "...application id...",
                "secret": "...application secret key..."
            },
            "httpResponse": true
        },
        "a": "Hello world!",
        "b": 42
    }
}

2.3. Result

If __reserved.httpResponse == true then the result structure should contain three fields

statusCode
headers
response

Examples:

Success

{
    "jsonrpc": "2.0",
    "id": "0",
    "result": {
        "statusCode": 200,
        "headers": { },
        "response": "somevalue"
    }
}

Error

{
    "jsonrpc": "2.0",
    "id": "0",
    "error": {
        "code": 404,
        "message": "Not Found",
        "data": {
            "statusCode": 404,
            "headers": { },
            "response": [ "Error data!" ]
        }
    }
}

3. Implementing Azure SDK Test Service

Eeach swagger operation may have several corresponded API functions. A service developer should decide which type of API functions should be implemented.

2.0 KiB Исходник Постоянная ссылка Ответственный История