Автоматическое создание документов для разметки, если вы используете только автоматическое обнаружение, чтобы обнаружить таблицы БД

Question

Мне интересно, можем ли мы по-прежнему автоматически генерировать документацию Swagger API для нашего сервера API Loopback, если мы используем только функции автоматического обнаружения, описанные здесь:

https://docs.strongloop.com/display/public/LB/Discovering+models+from+relational+databases

Кто-нибудь знает, если это возможно? Если мы используем автообнаружение, я как-то сомневаюсь, что любые файлы .json для наших моделей будут записаны в наш серверный проект, и это затруднит процесс создания документов.

Answer 1

Оказывается, это возможно, и для этого нужно написать файлы моделей x.json для всех моделей со сценарием, а затем запустить сервер после завершения скрипта!

https://docs.strongloop.com/display/public/LB/Database+discovery+API

это стандартная практика для автоматического обнаружения, вот мой код, который выполняет эту задачу:

const loopback = require('loopback'); 
const fs = require('fs'); 
const path = require('path'); 
const async = require('async'); 

var ds = loopback.createDataSource('postgresql', { 
    'host': 'localhost', 
    'port': 5432, 
    'database': 'foo', 
    'username': 'bar', 
    'password': 'baz' 
}); 


ds.discoverModelDefinitions(function (err, models) { 

    async.each(models, function (def, cb) { 

    ds.discoverSchema(def.name, null, function (err, schema) { 
     if (err) { 
     console.error(err.stack || err); 
     cb(err); 
     } 
     else { 
     fs.writeFile(path.resolve(__dirname, 'server/models', def.name + '.json'), 
      JSON.stringify(schema), {}, cb); 
     } 
    }); 

    }, function (err) { 
    if (err) { 
     console.log(err.stack || err); 
     process.exit(1); 
    } 
    else { 
     console.log(' => Successfully wrote model data.'); 
     process.exit(0); 
    } 

    }); 
});