Как создать публичную документацию API веб-сервера с Doxygen? - PullRequest
0 голосов
/ 19 октября 2018

Я хотел бы построить webserver api с php и хочу сгенерировать публичную документацию для api endpoints с использованием doxygen.

Пока я знаю, как заставить doxygen использовать мою внутреннюю документацию кода, но я хотел бы создать вторую общедоступную документацию, которая описывает только конечные точки общедоступного веб-сервера.

Я бы хотелпоместить соответствующую документацию в мои контроллеры и действия так, чтобы любые изменения конечной точки могли обновляться одновременно при разработке вместо того, чтобы поддерживать код и документацию параллельно.Таким образом, в grenal мне нужен способ как-то пометить свои публичные документы и сделать их списком doxygen только для моей публичной документации.

Есть ли стандартный или лучший способ добиться этого?Какие необходимые шаги настройки?Есть ли какие-нибудь инструменты на основе кислорода, которые могут помочь?

Спасибо

Ответы [ 2 ]

0 голосов
/ 28 ноября 2018

Я наконец нашел решение сам.Правильный способ сделать это - использовать «OpenAPI» -инструменты, которые часто совместимы с синтаксисом swagger во всех распространенных языках программирования.(некоторые фреймворки даже предоставляют встроенную поддержку, например LoopBack) Спецификации OpenAPI предназначены для создания документации только для внешних устройств, описывающей общедоступные интерфейсы / конечные точки API

0 голосов
/ 19 октября 2018

Некоторые отправные точки:

  • Вам нужен второй файл конфигурации doxygen (Doxyfile) с соответствующими настройками для обоих случаев
  • вам, вероятно, нужно что-то сделать с такими командами, как \if, \ifnot \else, \endif, \cond и \endcond, а также ENABLED_SECTIONS, см. Документацию.
  • в зависимости от названий функций и т. Д. МожетМожно использовать EXCLUDE_SYMBOLS
  • , в зависимости от того, как все настроено, возможно уменьшить внешний набор файлов.
...