石板 vs. Swagger - 哪个更好，哪个选项更多？
我需要记录我的API。我必须使用其中之一Slate或者Swagger。我想知道哪一个选项更多、优缺点和哪一个更好。 最初的回答： 如果你想要更多的选项和灵活性，那么选择Slate是更好的选择。但是，Swagger有更广泛的社区支持和更容易上手的界面。
Django rest APIs，自动化文档？
我尝试在编写视图集并使用 django rest docs 的同时记录API。我遇到了以下问题： 如果我尝试发送反向关联字段的值，它会采用值列表，但是当在表单数据中发送数据时，它会作为字符串出现。 文档UI中没有文件上传选项。 以下是我的代码： models.pyclass Area...
如何从Swagger文档生成静态HTML文件？
我使用一个yaml文件创建了一个Swagger文档，该文件位于：api/swagger/swagger.yaml 现在我想分享一个静态 HTML 文档及其定义，但在 Swagger 项目 上已经声明，他们不打算支持 HTML 的生成。 如何从 Swagger 项目生成一个静态 HTML 文件？
我该如何使用Swagger的模型部分？
在Swagger API文档中，除了API数组之外还有一个模型对象条目，但没有关于它的文档说明。我该如何使用这个“models”部分？ { apiVersion: "0.2", swaggerVersion: "1.1", basePath: "http://petstor...
在Swagger JSON格式中生成WebAPI文档
我使用 .Net 4.5 创建了一个 WebAPI，并希望使用 Swagger 对其进行文档化。 我已经在我的 .Net 项目中添加了 swagger-ui。现在，当我浏览到 ../swagger-ui/index.html 时，它成功地以 swagger UI 格式打开了 pet store...
Python模块/包名称的Sphinx apidoc部分标题
当我运行 sphinx-apidoc 然后运行 make html 时，它会生成文档页面，其中包含“子包”和“子模块”部分，以及目录（TOC）中每个模块/包名称末尾的“模块”和“包”字样。如何在不编辑Sphinx源代码的情况下防止写入这些额外的标题？ 以下是我想要制作的示例文档页面（请注意T...
使用setuptools自动生成Python项目文档
我创建了一个演示项目，它使用setuptools并具有以下结构：project/ |- pizza/ | |- __init__.py | `- margherita.py | |- README.rst |- setup.cfg `- setup.py 我正在尝试使用S...
“Remotable”是什么意思？
当Android API文档谈论“可远程对象”时，它们是什么意思？ 例如，IBinder的API文档声明： 此接口描述与远程对象交互的抽象协议。 但我搜索了一下，似乎找不到任何定义，比如“可远程对象是一个... blah blah blah...”。
Spring Rest Doc无法生成HTML。
我逐字遵循了Spring Rest Doc的入门指南，但是我无法从生成的片段中获得任何html文件。 片段在我配置的目录（build/generated-snippets）中生成得很好，但我看不到任何html5/目录以从片段中生成的html文件。 文档在某个时候说要如何将文档打包到jar文...
如何使用 OpenAPI Generator 生成 API 文档？
我刚接触 OpenAPI 3.0.0。 我已经成功地使用一个 OpenAPI生成器 创建了一个Java客户端库。 但是，OpenAPI生成器可以生成API客户端库（SDK生成），服务器存根，文档。因此，我想知道是否有可用的命令或步骤来生成HTML文档，并自定义文档模板。