在midwayjs中使用egg-swagger-doc

本文详细介绍如何在Egg.js框架中配置并使用Swagger插件,包括设置cookie签名密钥、Swagger文档信息如标题、描述及版本等,同时展示了如何禁用自动路由注册以避免注入对象找不到的问题。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

config.default.ts 配置设置

export = (appInfo: any) => {
  const config: any = {};

  // use for cookie sign key, should change to your own and keep security
  config.keys = appInfo.name + '_1533201820393_3738';

  config.swaggerdoc = {
    dirScanner: './app/controller',
    apiInfo: {
      title: 'egg-example-api',
      description: 'example for swaggerdoc',
      version: '1.0.0',
    },
    schemes: ['http'],
    enable: true,
    routerMap: false, // 禁止自动注册路由, 否则会找不到注入对象
  };

  return config;
};

plugin.ts 插件引入

// 引入egg-swagger-doc插件
export const swaggerdoc = {
  enable: true,
  package: 'egg-swagger-doc',
};

代码示例地址

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值