Как вы могли бы теперь, структура Loopbackjs отображает explorer interface на основе swagger, раскрывая конечные точки API и кратко объясняя методы. Проблема в том, что этот интерфейс немного интерактивен.Где я могу найти/изменить метаданные модели Loopbackjs?
мне нужно предоставить (МОГ) документацию API-Документы для моего API, и я в настоящее время добавления @annotations в/общих/моделях JS файлов, но я подозреваю, что я заново изобретать колесо здесь. Для swagger-ui/loopback-explorer для отображения своего интерфейса конечные точки должны уже отображать какие-то метаданные, не так ли?
Я хотел бы получить это и заполнить его описанием, примерами, пользовательскими кодами состояния и без кнопок «попробуйте». Пользователи, которые увидят это, не будут ценить так много интерактивности.
Да, это действительно помогает. Это требует некоторой работы для сопоставления исходных свойств с ключами Apidocs (путь к url, сводку к заголовку, метод для ввода и т. Д. И т. Д.). Я буду копаться, чтобы посмотреть, как изменять описания и добавлять другие многословия к маршрутам по умолчанию. – amenadiel
Если вы посмотрите на файл Model.json, вы увидите «Методы: []» внизу. Когда-нибудь (скоро?), Это будет место для изменения ваших описаний для различных Методов. До сих пор я просто создал еще один JSON-файл для описания карт в методах, которые вы найдете в Swagger, и поддерживайте это параллельно модели JSON. Учитывая, что вы все равно будете сопоставлять Apidocs, это просто добавит немного больше работы для вашего преобразования. – tonyStrong
Я бы хотел увидеть это :), в настоящее время даже после моих преобразований данных прозвища, такие как '' 'Dataset_prototype ___ findById__filter''', немного неестественны. – amenadiel