如何在环回3中从手动创建的路由和控制器添加API文档？

Question

这是RESTful API文档，可以通过模型环回自动创建。我需要从手动添加的路由/控制器中添加另一个API文档。可能吗？ Auto generated swagger API documentation by loopback 3 from models

Answer 1

您可以使用“远程方法定义”中的“描述”键。

Users.remoteMethod('getuserDetails', { isStatic: false, ** description **: 'Get user details using User-id. (for admin)', accepts: [{ arg: 'data', type: 'object', description:'Description of data argument' required: true, }, ], http: { verb: 'post', path: '/user-details', ** description **:'Description endpint' }, returns: { arg: 'result', type: 'object', }, });