guillotina-swagger 1.0.14

配置

可用的config.json选项

{
    "swagger": {
        "authentication_allowed": false,
        "base_configuration": {
            "swagger": "2.0",
            "info": {
                "version": "",
                "title": "Guillotina",
                "description": "The REST Resource API"
            },
            "host": "",
            "basePath": "",
            "schemes": [],
            "produces": [
                "application/json"
            ],
            "consumes": [
                "application/json"
            ],
            "paths": {},
            "definitions": {}
        },
        "index_html": null
    }
}

查看资源的swagger

在任何URL后追加@docs： https://:8080/@docs。

生成swagger文档

guillotina_swagger读取服务配置。

您可以通过提供以下任一选项的swagger配置来提供额外的swagger配置提示

• ignore: 防止swagger聚合它

• additional_paths: 为此配置提供要使用的额外路径列表（在这里考虑路由）

• display_permission: 如果您不想显示权限设置，请将此设置为false

• tags: 使用哪些标签

1.0.14 (2019-06-18)

• 限制g兼容

1.0.13 (2018-09-26)

• 如果未设置，则提供版本 [vangheem]

1.0.12 (2018-09-20)

• 能够自定义swagger index.html文件 [vangheem]

1.0.11 (2018-09-14)

• bump

1.0.10 (2018-09-13)

• 更多文档和支持，以自定义生成的swagger定义的更多部分。 [vangheem]

1.0.8 (2017-06-19)

• 添加权限到文档 [vangheem]

1.0.7 (2017-06-18)

• 调整UI [vangheem]

1.0.6 (2017-06-18)

• 自动检测认证令牌，并提供自己的授权头 [vangheem]

1.0.5 (2017-06-13)

• 如果提供，还可以从vhm拉取swagger的basePath [vangheem]

1.0.4 (2017-06-13)

• 在swagger中使用vhm进行主机设置 [vangheem]

1.0.3 (2017-06-13)

• 注意vhm

1.0.2 (2017-06-12)

• 可以为swagger提供自定义的base_url [vangheem]

1.0.1 (2017-06-07)

• 修复获取资源路径的问题

1.0.0 (2017-04-04)

• 初始发布