node-restify 路径可以与 swagger 一起使用吗？

Question

node-restify 库允许使用像 /foo/:id 这样的路径。大摇大摆可以处理这样的路径吗？即类似的东西？

var getFoo = {
    'spec': {
        'description': 'foo library',
        'path': '/foo/:id',
        'summary': 'return foo by id',
        'type': 'string',
        'produces': ['application/json']
    },
    'action': getFooObject()
};
swagger.addGet(getFoo)

当我在我的应用中尝试这个时，http://locahost:3001/api-docs 页面看起来像：

{
    apiVersion: "0.0.1",
    swaggerVersion: "1.2",
    apis: [ 
        {
            path: "/foo"
        }
    ]
}

我尝试使用 \ 字符转义双冒号。但这并没有什么不同。还尝试用双引号替换单引号。还是没有区别。我正在使用 swagger-node-restify 库，它是来自 swagger-node 存储库的分支。我做错了什么？

Answer 1

您正在描述一个 swagger 1.2 项目，该项目有多个文件来描述它。您可以在此处阅读有关 swagger 1.2 规范的更多信息：

https://github.com/OAI/OpenAPI-Specification/blob/master/versions/1.2.md

因此，您的 API 将不会在 api-docs 位置进行描述。根据您上面的描述，它应该显示在api-docs/foo。

请注意，/api-docs 称为资源列表，它指向 Api 声明，该声明相对于 api-docs 托管为 /foo。

最后一点，swagger 规范 1.2 已经过时，而 2.0 的工具要好得多。考虑将您的项目升级到swagger-node 或其他。