如何将 fastify swagger api 描述保存到本地文件

Posted

技术标签:

【中文标题】如何将 fastify swagger api 描述保存到本地文件【英文标题】:How to save fastify swagger api description to local file 【发布时间】:2022-01-24 04:04:16 【问题描述】:

您好,启动项目时是否有可能将 API swagger YAML 保存到本地文件?我正在使用 fastify-swagger 插件

使用exposeRoute启用true并调用'/documentation/yaml' API允许通过浏览器下载YAML,但我需要在最初启动项目时生成此YAML文件并将其保存到项目内部。

【问题讨论】:

【参考方案1】:

是的,你可以这样做:

// .. your code
fastify.register(require('fastify-swagger'),  ... )
await fastify.listen(8080)

// after the ready or listen call
const yaml = fastify.swagger( yaml: true )
require('fs').writeFileSync('./swagger.yml', yaml)

【讨论】:

以上是关于如何将 fastify swagger api 描述保存到本地文件的主要内容,如果未能解决你的问题,请参考以下文章

Swagger常用注解

如何将 swagger 导入带有环境的邮递员?

无论如何在 Nest.js 中使用 Fastify 获取请求、响应的类型接口

如何使用 Prometheus 和 Grafana 监控 Fastify 应用程序?

如何在Nancy中使用Swagger生成API文档?

如何将 swagger 2.0 JSON 文件分解为多个模块