Создание публичной и приватной документации Open API из файла yaml - PullRequest
0 голосов
/ 08 октября 2018

У меня есть документ OpenAPI для описания некоторых конечных точек.Некоторые из этих конечных точек должны быть общедоступными (видимыми для конечных пользователей) и другими частными (видимыми только для команды разработчиков).

Я хотел бы знать, если есть способ создать только 1 файл yaml, содержащий все APIметоды и сгенерировать 2 страницы документа (1 для общедоступных конечных точек и другое для частных).Есть ли флаг или конфигурация, которые позволили бы мне различать тип конечной точки и делать ее видимой или скрытой?

Мне также нужно сделать это на уровне запроса.Есть некоторые конечные точки, в которых тело запроса имеет некоторые «приватные» атрибуты (о которых конечный пользователь не должен знать).Предполагая, что первое утверждение верно (есть способ, которым я могу создать 2 API-документа из одного файла YAML), возможно ли будет скрыть некоторые атрибуты модели запроса при применении общедоступной документации псевдонимов?

...