Swagger Yard 是一个用于生成 Swagger 文档的 Ruby Gem。它可以将生成的 JSON 文件放在项目的任意位置,具体位置取决于开发者的需求和项目的结构。
一般来说,开发者可以选择将生成的 JSON 文件放在项目的根目录下,或者放在一个专门用于存放文档的目录中。这样可以方便地与其他项目文件进行管理和版本控制。
对于一个典型的 Ruby on Rails 项目,可以将生成的 JSON 文件放在 public
目录下,这样可以通过项目的 URL 直接访问到该文件。例如,可以将生成的 JSON 文件命名为 swagger.json
,然后通过 http://example.com/swagger.json
来访问。
需要注意的是,Swagger Yard 只负责生成 Swagger 文档的 JSON 文件,对于如何将该文件部署到服务器上以供访问,需要开发者根据自己的项目和服务器环境进行相应的配置和部署。
领取专属 10元无门槛券
手把手带您无忧上云