api-doc

3зной

1ответ

Yii2 apidoc не позволит мне добавить мой проект и структуру yii в те же документы.

Я строю документацию для проекта, написанного в yii2, используя yiisoft/yii2-apidoc (# 0.2.4). Я создал сценарий оболочки для публикации документов, и он отлично работает, когда я включаю только файлы

0зной

1ответ

Nodejs/apidocjs: Как визуализировать сгенерированную документацию по определенному URL-адресу без шаблона

Я пишу apidocs для проекта nodejs, который кто-то написал. Я хотел бы, чтобы страница документации отображалась, когда кто-то посещает «myurl.com/docs/api». Мой каталог документации находится под «app

1зной

1ответ

rails api dock синтаксис

ROR Api Dock всегда начинается с синтаксиса метода. Мой пример будет link_to: link_to(name = nil, options = nil, html_options = nil, &block) public Мой вопрос на "name=nil" или "something = nil", кото

0зной

1ответ

Как работают два @apiName в одном файле класса в apiDocJ?

У меня есть сервлет, который может обрабатывать несколько путей и делать разные вещи на основе этого. Я хочу документировать различные функции в файле класса, используя http://apidocjs.com, но не могу

2зной

1ответ

Как включить общие ответы на ресурс raml

У меня есть документы raml и попробуйте добавить новые документы API в эти документы. Я прошел через основные документы RAML. У меня есть файл raml как. И фактическое содержание RAML в test.raml #File

0зной

1ответ

API Doc apiGroup и apiName не работают должным образом

Это мое первое использование apiDocs, и я точно следую приведенной документации. Проблема в том, что я определяю apiName и apiGroup, но на выходе отображается только apiGroup. Это мое определение: /**

1зной

1ответ

Как сделать apidocs использовать пакеты вместо модулей в sphinx-apidoc

Я использую docstrings для документирования кода python и sphinx-autodoc для генерации HTML-кода apidoc. Структура моих пакетов выглядит следующим образом: mainpackage.subpackage.module, я хочу, чтобы

0зной

1ответ

Как использовать springfox менее инвазивным способом?

Я хочу использовать springfox для создания документов API в проекте springmvc. Но, используя springfox, я должен добавить аннотацию java к контроллерам и моделям, что очень инвазивно. Итак, что я могу