Json Swagger API规范文件名

Json Swagger API规范文件名,json,api,rest,api-design,swagger,Json,Api,Rest,Api Design,Swagger,我试图使用Swagger为我们正在构建的API创建API文档,我以前从未使用过它 Github上的文档说,资源列表不需要位于/api文档,各种资源文件需要位于/api文档/书籍等等 这使得命名文件和文件夹非常棘手。我想他们希望这些文件没有文件名,而不是有一个名为/api docs的文件夹。它必须是一个无扩展名的文件,然后你不能将资源放在api docs文件夹中,因为你不能调用该文件夹,所以他们建议使用一个名为/listings的文件夹 这个文件夹不会出现在文档的URL结构中,因为您将资源中的ba

我试图使用Swagger为我们正在构建的API创建API文档,我以前从未使用过它

Github上的文档说,资源列表不需要位于/api文档,各种资源文件需要位于/api文档/书籍等等

这使得命名文件和文件夹非常棘手。我想他们希望这些文件没有文件名,而不是有一个名为/api docs的文件夹。它必须是一个无扩展名的文件,然后你不能将资源放在api docs文件夹中,因为你不能调用该文件夹,所以他们建议使用一个名为/listings的文件夹

这个文件夹不会出现在文档的URL结构中,因为您将资源中的baseURL设置为正确的路径,所以它是不可见的,但是看起来它必须是一个绝对路径,如果您想在多个服务器(本地和生产)上使用它,这会很尴尬

也许我就是不明白,但这一切似乎都是疯狂的

所以,我有两个问题

1) 我可以给我的资源列表文件和资源文件一个.json扩展名吗?这很有意义,因为它是一个JSON文件

2) 我可以在我的资源文件中的baseURL中使用资源列表文件的相对路径吗

理想情况下,我的文件结构会更平坦,就像这样

/api-docs
    resources.json
    books.json
    films.json
招摇过市是否足够灵活来做到这一点


如果这有什么区别的话,它就是一个IIS服务器(例如,如果解决方案需要路由)。

我能够将模型文件放在web根目录下的文件夹中,并可以像这样引用它们

 $ref: '/models/model.yml#/MyObject'
相对路径也可以在没有前导斜杠的情况下工作

   $ref: 'models/model.yml#/MyObject'
在model.yml中,我可以像这样在同一个文件中引用其他对象

 $ref: '#/MyObject2'.
但是,我只能获取主swagger文件来导入模型文件。我无法使一个模型文件交叉引用另一个模型文件

我使用的是TomcatWeb服务器,但原理是一样的