Egg-Swagger-Doc 使用教程

最新推荐文章于 2024-08-15 09:53:54 发布

何红桔Joey

最新推荐文章于 2024-08-15 09:53:54 发布

阅读量495

点赞数 20

本文链接：https://blog.csdn.net/gitblog_00871/article/details/141211750

版权

Egg-Swagger-Doc 使用教程

egg-swagger-docswagger-ui for egg项目地址:https://gitcode.com/gh_mirrors/eg/egg-swagger-doc

项目介绍

Egg-Swagger-Doc 是一个为 Egg.js 框架提供的 Swagger UI API 文档自动生成插件。通过该插件，开发者可以轻松地为他们的 RESTful API 生成详细的文档，从而提高前后端协作的效率。该插件支持 JSON Schema，并且可以与 TypeScript 一起使用。

项目快速启动

安装

首先，你需要在你的 Egg.js 项目中安装 egg-swagger-doc 插件。

npm install egg-swagger-doc --save

配置

接下来，在 config/plugin.js 中启用插件：

exports.swaggerdoc = {
  enable: true,
  package: 'egg-swagger-doc',
};

然后在 config/config.default.js 中进行详细配置：

exports.swaggerdoc = {
  dirScanner: './app/controller',
  apiInfo: {
    title: 'egg-swagger',
    description: 'swagger-ui for egg',
    version: '1.0.0',
  },
  schemes: ['http', 'https'],
  consumes: ['application/json'],
  produces: ['application/json'],
  securityDefinitions: {
    apikey: {
      type: 'apiKey',
      name: 'Authorization',
      in: 'header',
    },
  },
  enableSecurity: true,
  // other options
};

使用

在控制器文件中，你可以使用注释来定义 API 文档：

/**
 * @controller UserController
 */
class UserController extends Controller {
  /**
   * @summary 获取用户信息
   * @description 获取指定用户的信息
   * @router get /api/user/{id}
   * @request path string *id 用户ID
   * @response 200 schema.User 用户信息
   */
  async show() {
    const { ctx } = this;
    const userId = ctx.params.id;
    ctx.body = await ctx.service.user.find(userId);
  }
}