Я пытаюсь очистить свою документацию по коду Python и решил использовать sphinx-doc потому что он хорошо выглядит. Мне нравится, как я могу ссылаться на другие классы и методы с помощью таких тегов, как: :class:`mymodule.MyClass` About my...

Я создаю API RESTfull, используя Symfony2.1 с FOSRESTBundle, и я использую NelmioApiDocBundle для создания автоматической документации. У меня есть запрос PUT, в котором пользователь должен отправить один параметр, но мне не нужно создавать форму...

По умолчанию Swagger анализирует элементы данных класса, чтобы документировать объекты, используемые в качестве параметров или возвращаемые данной веб-службой. Если вы используете Jackson, аннотации Jackson предоставляют гораздо более точное описание...

Когда я запускаю sphinx-apidoc , а затем make html , он создает страницы документов, которые имеют разделы «Подпакеты» и «Подмодули», а также «модуль» и «пакет» в конце каждого имени модуля / пакета в таблице содержания (TOC). Как я могу...

Я использую динамические формы (определяемые как службы (!)), чтобы включать/отключать некоторые поля для конкретного запроса (POST/PUT/PATCH). Я хочу, чтобы это отображалось в ApiDoc автоматически, передавая параметры для формы как описано в...

Я использую гем grape-swagger и не могу получить гем на основе Grape API правильно описан в Swagger. Использование: grape (0.11.0) и grape-swagger (0.10.1) Когда я включаю список Swagger json, я получаю этот вывод со списком всех конечных...

Я работаю над настройкой сервера авторизации OAuth 2.0 с использованием безопасности Spring. Я хотел бы задокументировать API-интерфейсы OAuth 2.0 с помощью Swagger. Как мне это сделать?

Я работал над проектом с Java-фреймворком Spring Boot, где ребята автоматизировали генерацию документов API. Каждый раз, когда вы запускаете тесты в стиле BDD/Integration, из тестов mocha создается файл blue print API. Затем он запустил схему...

Я использую openapi-generator последней версии ( 4.2.2 ) для создания Java Spring API. Конфигурация выглядит так: openApiGenerate { generatorName = "spring" inputSpec = "${projectDir}/src/main/resources/api/users-spec.yaml"...

Я пытаюсь установить laravel-apidoc-generator ( https://github.com/mpociot/laravel-apidoc-generator ) в моем последнем Lumen REST API. Это моя версия Lumen: Lumen (8.0.1) (Laravel Components ^8.0) Это моя версия PHP: PHP 7.3.22 . Когда я...