Question

如果我有这段代码：

class MyApp():
    def __init__(self):
        self.bottle = Bottle()
        self.bottle.route('/')(self.show_api)
        self.bottle.route('/api/')(self.show_api)
        self.bottle.route('/api/item', method='PUT')(self.save_item)

    def show_api(self):
        return <JSON representation of the API?>

是否有可能从中获取JSON格式的REST API文档？出于某种原因，self.bottle.routes没有返回任何有用的东西。

谢谢！

Answer 1

实际上，生成JSON API描述的正确方法似乎是：

from collections import defaultdict
import json

def show_api(self):
    api_dict = defaultdict(dict)

    for route in self.bottle.routes:
        api_dict[route.rule]['url'] = 'http://myhost:port{}'.format(route.rule)
        api_dict[route.rule]['method'] = route.method

        # additional config params
        for key in route.config:
            api_dict[route.rule][key] = route.config[key]

    return json.dumps(api_dict)

Answer 2

Bottle.route()旨在用作装饰者：

@app.route('/hello/:name')
def hello(name):
    return 'Hello %s' % name

所以它返回一些有用的东西：装饰函数。

然后，您可以使用app.routes获取已声明路由的列表。

print(app.routes)

输出：

[<GET '/hello/:name' <function hello at 0x7f4137192e18>>]

函数不是直接JSON可序列化的。但您可以轻松使用str来获取字符串表示。

有没有办法从Bottle路由自动生成REST API JSON描述

2 个答案: