Я хотел бы построить webserver api
с php
и хотите создать публичную документацию для api endpoints
с помощью doxygen
,
До сих пор я знаю, как заставить doxygen работать с моей внутренней документацией кода, но я хотел бы создать вторую общедоступную документацию, которая описывает только конечные точки общедоступного веб-сервера.
Я хотел бы поместить соответствующую документацию в мои контроллеры и действия, чтобы любые изменения в конечной точке могли обновляться одновременно при разработке вместо того, чтобы поддерживать код и документацию параллельно.
Так что в grenal мне нужен способ как-то пометить мои публичные документы и сделать их в белый список doxygen только для моей публичной документации.
Существует ли стандартный или передовой метод для достижения этой цели?
Какие необходимые шаги настройки?
Есть ли какие-нибудь инструменты на основе кислорода, которые могут помочь?
Спасибо
Некоторые отправные точки:
\if
, \ifnot
\else
, \endif
, \cond
а также \endcond
так же хорошо как ENABLED_SECTIONS
см. документацию.EXCLUDE_SYMBOLS
Я наконец нашел решение сам. Правильный способ сделать это — использовать «OpenAPI» -инструменты, которые часто совместимы с синтаксисом swagger во всех распространенных языках программирования. (некоторые фреймворки даже предоставляют встроенную поддержку, например LoopBack)
Спецификации OpenAPI предназначены для создания документации для внешних устройств, описывающей только открытые интерфейсы / API-конечные точки.