asyncswagger11 0.12.4

来自swagger.py

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

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

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

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

API

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

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

#!/usr/bin/env python3

import json
import anyio

from asyncswagger11.client import SwaggerClient
from asyncswagger11.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 anyio.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 in ws:
        if not isinstance(msg, WebsocketDataMessage):
            break
        elif not isinstance(msg, WebsocketTextMessage):
            continue # ignore bytes

        msg_json = json.loads(msg.data)
        if msg_json['type'] == 'StasisStart':
            await nursery.start_soon(run,ari,msg_json)

if __name__ == "__main__":
    anyio.run(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。

注意，目前无法单独测试此模块。以前的版本需要一个修改过的 httpretty 版本。

待办事项：使用本地服务器代替。