Как добавить документацию API из созданных вручную маршрутов и контроллеров в loopback 3?

Question

Это документация по RESTful API, автоматически созданная с помощью обратной петли из моделей. Мне нужно добавить другую документацию API из моих добавленных вручную маршрутов / контроллеров. Является ли это возможным? Автоматически сгенерированная документация API Swagger по шлейфу 3 из моделей

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', }, });