文档生成
配置文件
配置生成

配置文件

首先在项目目录下运行 `opss gen-type` 或者 `opss gt` 生成配置文件。配置文件包含 `opss.ts`、`opss-type.ts`、`opss-schema.ts` 三个文件。

以下是这三个配置文件及其作用的概述:

文件名作用
opss.ts用于描述要分析的控制器、入口文件有哪些,有哪些文件需要前后端共享。
opss-type.ts这是 opss.ts 中的配置的类型申明
opss-schema.ts如果你需要扩展你的文档,则需要有一个 openapi 规范的数据类型,具体使用方法,可以参考: https://github.com/cnpap/opss-api-demo/blob/main/opss.ts 中的根据 UseGuards 装饰器提供认证请求头。

您可以根据需要修改这些配置文件来自定义 opss 的行为,请参考下级目录中的参数描述以及配置用例。