28得票2回答
Django rest APIs,自动化文档?

我尝试在编写视图集并使用 django rest docs 的同时记录API。我遇到了以下问题: 如果我尝试发送反向关联字段的值,它会采用值列表,但是当在表单数据中发送数据时,它会作为字符串出现。 文档UI中没有文件上传选项。 以下是我的代码: models.pyclass Area...

27得票7回答
如何从Swagger文档生成静态HTML文件?

我使用一个yaml文件创建了一个Swagger文档,该文件位于:api/swagger/swagger.yaml 现在我想分享一个静态 HTML 文档及其定义,但在 Swagger 项目 上已经声明,他们不打算支持 HTML 的生成。 如何从 Swagger 项目生成一个静态 HTML 文件?

8得票1回答
使用Node.js/Express编写的现有应用程序需要创建API文档

我有一些用纯旧版express编写的私有API。是时候公开并提供一些API文档了。 目前我不想重新编写我的express应用程序以将API文档集成到代码中。主要是因为我不确定使用什么框架或规范来记录我的API,我不想被锁定在一个特定的东西上。 我想将文档作为子资源的一部分提供(即我不想运行...

9得票3回答
Python Azure函数的API文档(Swagger UI)

我们基于Azure function构建了API,所有的API都是基于Python的。我知道APIM可以很好地导入Azure function并创建和管理API。然而,我正在寻找一种轻量级且快速的解决方案,以便开发人员可以在彼此之间进行工作。 Swagger在Java生态系统中非常流行,我们...

17得票2回答
使用setuptools自动生成Python项目文档

我创建了一个演示项目,它使用setuptools并具有以下结构:project/ |- pizza/ | |- __init__.py | `- margherita.py | |- README.rst |- setup.cfg `- setup.py 我正在尝试使用S...

8得票2回答
Rails 5的API文档工具

我有一个只有API的Rails应用程序,需要为前端开发人员提供文档。这是我的第一次经历。 你在这种情况下使用什么工具?请注意,我正在使用Rails 5 API而不是Grape。 我测试了Apipie、swagger-blocks和swagger-docsgems,但它们已经过时或存在缺陷。...

18得票3回答
在Swagger JSON格式中生成WebAPI文档

我使用 .Net 4.5 创建了一个 WebAPI,并希望使用 Swagger 对其进行文档化。 我已经在我的 .Net 项目中添加了 swagger-ui。现在,当我浏览到 ../swagger-ui/index.html 时,它成功地以 swagger UI 格式打开了 pet store...

11得票1回答
“Remotable”是什么意思?

当Android API文档谈论“可远程对象”时,它们是什么意思? 例如,IBinder的API文档声明: 此接口描述与远程对象交互的抽象协议。 但我搜索了一下,似乎找不到任何定义,比如“可远程对象是一个... blah blah blah...”。

36得票4回答
石板 vs. Swagger - 哪个更好,哪个选项更多?

我需要记录我的API。我必须使用其中之一Slate或者Swagger。我想知道哪一个选项更多、优缺点和哪一个更好。 最初的回答: 如果你想要更多的选项和灵活性,那么选择Slate是更好的选择。但是,Swagger有更广泛的社区支持和更容易上手的界面。

9得票1回答
如何使用 OpenAPI Generator 生成 API 文档?

我刚接触 OpenAPI 3.0.0。 我已经成功地使用一个 OpenAPI生成器 创建了一个Java客户端库。 但是,OpenAPI生成器可以生成API客户端库(SDK生成),服务器存根,文档。因此,我想知道是否有可用的命令或步骤来生成HTML文档,并自定义文档模板。