Описание тега api-doc

Вопросы с тегом
Встроенная документация для веб-API RESTful. apiDoc создает документацию из аннотаций API в исходном коде.
4 ответа

Генерация документации REST-API из юнит-тестов

Я хочу автоматически задокументировать мой REST-API. Я знаю, что для этого есть много инструментов, но я хочу создать документацию из моих модульных тестов. Причина в том, что я хочу, чтобы документация отражала то, что тестировалось, а что нет. Тем…
26 фев '16 в 10:06
0 ответов

APIDOCJS - Как сделать "тело" доступным, чтобы выставить значения как "параметры"

У меня есть некоторые конечные точки в моем API, которые требуют данных, отправляемых непосредственно в теле. Но я не мог найти что-то вроде @apiParam ни @apiParamExample таким образом, что инструмент генерирует "текстовое поле" для тела (например, …
13 сен '17 в 11:47
1 ответ

Ссылка на пакет, сгенерированный через Sphinx-apidoc

При использовании sphinx-apidoc для генерации .rst файлы, выходные данные не содержат меток: dessn.examples package ====================== .. automodule:: dessn.examples :members: :undoc-members: :show-inheritance: Subpackages ----------- .. toctree…
27 мар '16 в 12:25
2 ответа

Документация Swagger API в NodeJS

Я сталкиваюсь с проблемой при настройке Swagger. Как я могу реализовать Swagger для того, чтобы в моем проекте node-express написать API Doc для существующих API? Я посмотрел пакеты swagger, swagger-ui и swagger-ui-dist npm. Но не получить желаемый …
06 июл '18 в 11:54
1 ответ

Документация по API NLTK 3, выпуск 4

Привет всем просто быстрый вопрос. Я работаю с NLTK версии 3 выпуска 4 (Python 3). Я могу найти только документы API для версии 3.0, и кажется, что между выпусками произошел некоторый износ. Например, документы API (для 3.0) утверждают, что nltk.Con…
13 фев '15 в 16:00
1 ответ

Как я могу использовать раздел моделей Swagger?

Внутри документации API Swagger внутри массива jis, рядом с массивом apis, есть запись объекта модели, но нет документации об этом. Как я могу использовать эту часть "моделей"? { apiVersion: "0.2", swaggerVersion: "1.1", basePath: "http://petstore.s…
04 мар '13 в 08:43
1 ответ

Как две функции @apiName в одном файле класса в apiDocJs?

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

Добавление документации в приложение django - конфликт с angular

Я создал документацию для моего приложения Django, используя библиотеку apidoc. Он создает документы с использованием угловых. Приложение работает на Heroku. Документы работают хорошо, когда я открываю index.html файл, но я не могу открыть их через …
04 апр '17 в 12:43
0 ответов

Как определить переменные для этого шаблона в Swagger

Как я могу определить формат swagger для следующего фрагмента, независимо от того, является ли этот API get,put или некоторыми другими методами, моя проблема заключается в определении переменных { "response":[ { "value":"20", "timestamp":"12/09/2017…
05 янв '19 в 09:39
0 ответов

Apidoc - Node.js не показывает мне @apiName

У меня проблема с моей документацией по API. Я хочу сделать документацию, но @apiName не появляется... Я пытался добавить @appVersion, но это не сработало. Это моя документация /** * @api {post} /createBook * @apiGroup Books * @apiName CreateBook * …
21 фев '19 в 20:01
7 ответов

Как создать статический HTML-файл из документации Swagger?

Я создал Swagger документацию с yaml файл под: api/swagger/swagger.yaml Теперь я хочу поделиться статическим html-документом с его определением, но в проекте swagger было заявлено, что они вообще не планируют поддерживать html-генерацию. Как я могу …
03 ноя '16 в 16:50
0 ответов

Библиотека узлов для создания демонстрационных страниц для исчерпывающего тестирования API

Учитывая API, я могу представить, что может существовать библиотека javascript (серверная часть в Node), которая может создавать демо-страницы для исчерпывающего тестирования этих API-методов. Примерно так: https://developers.google.com/apis-explore…
24 сен '13 в 17:47
2 ответа

Документация по функциям карты Scala Array (PSSQ #1)

PSSQ расшифровывается как возможно глупый вопрос о Scala:) Немного познакомимся с Scala, и в обязательном примере Hello World (код ниже) аргументы основной функции - это массив строк. object HelloWorld { def main(args: Array[String]): Unit = { args.…
12 апр '11 в 17:53
0 ответов

Добавлен шаблон по умолчанию для Apidocjs, но не добавлен новый шаблон

Теперь я установил новый шаблон на мой компьютер. https://github.com/jodacame/apidocjs-template-dark-Slate-Inspiration- Согласно документации в приведенной выше ссылке, я сделал следующее: git clone https://github.com/jodacame/apidocjs-template-dark…
10 окт '18 в 02:55
1 ответ

rails api док синтаксис

ROR Api Dock всегда начинается с синтаксиса метода. Мой пример будет link_to: link_to(name = nil, options = nil, html_options = nil, &block) public Мой вопрос на "name=nil" или же "something = nil" который я вижу в большинстве команд. Второй при…
28 апр '16 в 13:06
1 ответ

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

Это мое первое использование apiDocs, и я точно следую предоставленной документации. Проблема в том, что я определяю apiName и apiGroup, но в выводе отображается только apiGroup. Это мое определение: /** * @apiVersion 1.0.0 * @api {post} /users/regi…
23 июн '16 в 22:00
0 ответов

Apidoc для URL-адреса проверки подлинности Flask-JWT

Я начал использовать apidoc для генерации документации REST API. Я пробовал разные вещи с этим. В моем flask приложение на основе API, я использую JWT (в частности, flask-jwt) для аутентификации. Документ генерируется правильно, но запрос от докумен…
29 мар '16 в 05:41
2 ответа

Swagger редактировать API-документы?

Я новичок в разработке остальных веб-сервисов и сейчас пытаюсь добавить аутентификацию с помощью этого URL: http://developers-blog.helloreverb.com/enabling-oauth-with-swagger/ К сожалению, я застрял на первом шаге, когда говорится, что нужно редакти…
24 июл '15 в 00:51
1 ответ

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

Я использую строки документации для документирования кода Python и sphinx-autodoc для создания HTML-кода apidoc. Структура моих пакетов следующая: mainpackage.subpackage.moduleЯ хочу, чтобы apidocs связывался с классами из модуля как mainpackage.sub…
26 июн '16 в 01:17
0 ответов

Публично определенные определения APIDoc

Я использую apiDoc для документации в приложении Sails.js. И на прошлой неделе я видел, как кто-то определил ответы, используемые несколькими контроллерами в файле с именем api_definitions.js пример /* * @apiDefine UserSuccessExample * @apiSuccessEx…
23 янв '17 в 09:18