Каркас для визуализации частей спецификации Swagger - PullRequest
0 голосов
/ 11 декабря 2018

Моя документация по API состоит из 3 основных элементов - сгенерированной спецификации swagger.json, ссылки на API, которая только что отображается как swagger.json с использованием ReDoc, и рукописной документации по уценке с руководствами по ее использованию.

Мое желание состоит в том, чтобы включить части предоставленной Справочника API в рукописную документацию, и это будет обновляться.Так, например, было бы написанное от руки руководство о том, как проходить аутентификацию, и оно включало бы таблицу с

Моя первоначальная идея заключалась в том, чтобы расширить анализатор уценки, чтобы включить пользовательские теги, например [[url.com/swagger.json][/ endpointToRender]] или что-то в этом роде, и она выдаст информацию о конечной точке, например: ReDoc

Я надеялся, что что-то подобное уже существует, но не смог найти его.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...