Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

controller文件名带有'-'生成不了api文档 #12

Closed
qzcsgs opened this issue Feb 19, 2022 · 4 comments
Closed

controller文件名带有'-'生成不了api文档 #12

qzcsgs opened this issue Feb 19, 2022 · 4 comments

Comments

@qzcsgs
Copy link

qzcsgs commented Feb 19, 2022

// router.js
router.resources('xxx-test', '/api/xxx-test', controller.xxxTest);

// controller/xxx-test.js
class XxxTestController extends Controller {
  /**
   * #swagger-api
   * @function index
   * @summary 查询
   * @description #tags xxx-test
   */
  async index() {
      this.ctx.body = 'select!!!';
  }
@JsonMa
Copy link
Owner

JsonMa commented Feb 25, 2022

// router.js
router.resources('xxx-test', '/api/xxx-test', controller.xxxTest);

// controller/xxx-test.js
class XxxTestController extends Controller {
  /**
   * #swagger-api
   * @function index
   * @summary 查询
   * @description #tags xxx-test
   */
  async index() {
      this.ctx.body = 'select!!!';
  }

你的router应该指定处理方法,例如:controller.xxxTest.index,上面的示例只指定了controller文件,但是没有指定对应controller文件下的方法。

@qzcsgs
Copy link
Author

qzcsgs commented Feb 25, 2022

// router.js
router.resources('xxx-test', '/api/xxx-test', controller.xxxTest);

// controller/xxx-test.js
class XxxTestController extends Controller {
  /**
   * #swagger-api
   * @function index
   * @summary 查询
   * @description #tags xxx-test
   */
  async index() {
      this.ctx.body = 'select!!!';
  }

你的router应该指定处理方法,例如:controller.xxxTest.index,上面的示例只指定了controller文件,但是没有指定对应controller文件下的方法。

你可能看错了是resources这个函数,只需要指定到controller
而且我实际测试过,将文件上的'-'去掉后,文档可以正常生成

@JsonMa
Copy link
Owner

JsonMa commented Feb 25, 2022

// router.js
router.resources('xxx-test', '/api/xxx-test', controller.xxxTest);

// controller/xxx-test.js
class XxxTestController extends Controller {
  /**
   * #swagger-api
   * @function index
   * @summary 查询
   * @description #tags xxx-test
   */
  async index() {
      this.ctx.body = 'select!!!';
  }

你的router应该指定处理方法,例如:controller.xxxTest.index,上面的示例只指定了controller文件,但是没有指定对应controller文件下的方法。

你可能看错了是resources这个函数,只需要指定到controller 而且我实际测试过,将文件上的'-'去掉后,文档可以正常生成

好的,我已经复现了这个BUG,稍后发布一个修复的版本。

JsonMa added a commit that referenced this issue Feb 25, 2022
@qzcsgs
Copy link
Author

qzcsgs commented Feb 25, 2022

// router.js
router.resources('xxx-test', '/api/xxx-test', controller.xxxTest);

// controller/xxx-test.js
class XxxTestController extends Controller {
  /**
   * #swagger-api
   * @function index
   * @summary 查询
   * @description #tags xxx-test
   */
  async index() {
      this.ctx.body = 'select!!!';
  }

你的router应该指定处理方法,例如:controller.xxxTest.index,上面的示例只指定了controller文件,但是没有指定对应controller文件下的方法。

你可能看错了是resources这个函数,只需要指定到controller 而且我实际测试过,将文件上的'-'去掉后,文档可以正常生成

好的,我已经复现了这个BUG,稍后发布一个修复的版本。

好的,辛苦了

@JsonMa JsonMa closed this as completed Feb 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants