《第三篇，eggjs&swagger》

最新推荐文章于 2024-06-20 00:46:05 发布

zuweie

最新推荐文章于 2024-06-20 00:46:05 发布

阅读量2.7k

点赞数

分类专栏： Nodejs 文章标签： plugin app nodejs js

本文链接：https://blog.csdn.net/weixin_39527684/article/details/103594400

版权

草稿

摘要由CSDN通过智能技术生成

Swagger API

此篇在eggjs上，安装swagger，那么这个eggjs大概能用了。

egg-swagger-doc

在npmjs 上搜索 egg-swagger-doc，然后安装：

npm install --save egg-swagger-doc

打开插件
在app/config/plugin.js中配置

// {app_root}/config/plugin.js
exports.swaggerdoc = {
  enable: true,
  package: 'egg-swagger-doc',
};

配置插件

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: 'clientkey',
    //   in: 'header',
    // },
    // oauth2: {
    //   type: 'oauth2',
    //   tokenUrl: 'http://petstore.swagger.io/oauth/dialog',
    //   flow: 'password',
    //   scopes: {
    //     'write:access_token': 'write access_token',
    //     'read:access_token&#