aioswagger11 0.9.1

从swagger.py

Swagger.py是一个Python库，用于使用Swagger定义的API。

Swagger本身最好在Swagger主页上描述

Swagger是一个用于描述、生成、消费和可视化RESTful Web服务的规范和完整的框架实现。

Swagger规范 定义了如何使用Swagger描述API。

API

aioswagger11将从启用Swagger的RESTful API动态构建对象模型。

以下是一个简单的示例，使用Asterisk REST接口

#!/usr/bin/env python3

import json
import asyncio
import aiohttp

from aioswagger11.client import SwaggerClient
from aioswagger11.http_client import AsynchronousHttpClient

http_client = AsynchronousHttpClient()
http_client.set_api_key('localhost', 'hey:peekaboo')

async def run(ari,msg_json):
    channelId = msg_json['channel']['id']
    await ari.channels.answer(channelId=channelId)
    await ari.channels.play(channelId=channelId,
                    media='sound:hello-world')
    # In a real program you should wait for the PlaybackFinished event instead
    await asyncio.sleep(3)
    await ari.channels.continueInDialplan(channelId=channelId)

async def main():
    ari = SwaggerClient(
        "http://localhost:8088/ari/api-docs/resources.json",
        http_client=http_client)

    ws = ari.events.eventWebsocket(app='hello')

    async for msg_str in ws:
        if msg.type in {aiohttp.WSMsgType.CLOSED, aiohttp.WSMsgType.CLOSING}:
            break
        elif msg.type != aiohttp.WSMsgType.TEXT:
            continue # ignore

        msg_json = json.loads(msg_str)
        if msg_json['type'] == 'StasisStart':
            asyncio.ensure_future(run(ari,msg_json))

if __name__ == "__main__":
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())

数据模型

由 swagger_model 模块提供的数据模型几乎与原始 Swagger API 资源列表和 API 声明完全相同。这意味着如果您在文档中添加了额外的自定义元数据（例如 _author 或 _copyright 字段），它们将传递到对象模型中。我建议在自定义字段前加上下划线，以避免与未来版本的 Swagger 发生冲突。

有几个有意义的差异。

• 资源列表

• 添加了 file 和 base_dir 字段，它们引用了原始的 .json 文件。

• resource_listing 中的 api 数组对象包含一个 api_declaration 字段，这是从引用的 API 文档中处理后的结果。

• API 声明

• 添加了 file 字段，它引用了原始的 .json 文件。

测试

只需运行 python3 setup.py pytest。

请注意，测试此模块需要与 aiohttp 兼容的 httpretty 版本。