swagger-UI就像使用Bottle的python apis的rest api文档一样

Question

我使用Bottle开发了api。是否有像swagger-ui这样的库有助于查看文档和test apis？

Answer 1

为了设置基于瓶子的休息服务的招摇文档： 将swagger UI文件复制到Web容器

1. 您需要在Web服务器上托管的特定于UI的特定Web内容文件。

克隆https://github.com/swagger-api/swagger-ui.git并复制＆＃34; dist＆＃34;文件夹内容到您的Web容器docs资源目录。

例如，如果将dist文件夹内容复制到瓶子项目根文件夹下的docs目录，请将以下方法添加到您的Bottle实例中以适当地路由请求。

@app.get('/docs/<filename:re:.*>')
def html(filename):
    return static_file(filename, root='docs/')

**以下步骤适用于任何平台上的休息服务。但是，很少有框架（Java Jersey或Flask）具有内置的以下功能。 编辑json文件

1. 从您复制的文件中编辑index.html。此文件具有指向其余服务文档json的链接（由swagger加载/解析）

即更改index.html中的以下行以引用包含swagger结构中的其余服务文档的json文件。

url = "http://petstore.swagger.io/v2/swagger.json";

作为此json的起点，请参阅http://petstore.swagger.io/v2/swagger.json

这就是我们所需要的一切。启动

http://<hostname:port>/<path for swagger resources>/index.html 

以查看swagger文档。

Answer 2

没有用于生成Swagger REST定义的自动记录工具。在python中有太多的Web框架，为每个框架编写一个框架效率不高。我的建议是使用swagger-editor在 yaml 中编写Swagger REST定义，这比直接在json中编写更容易。

对于unittest，你可以尝试pyswagger，这是我在python中测试启用Swagger的REST服务所编写的工具。