documentation 相关问题

此标签仅供文档生成器使用。还包括语言和/或SDE标记。请勿使用要求提供文档或工具的链接,或批评供应商文档。

微服务的集中式 API 文档 [已关闭]

我和我的团队目前正在并行构建多个服务。我们的优势是从头开始构建所有服务。我希望能够自动显示所有 API 端点,

回答 3 投票 0

没有名称的 Swagger 字符串数组

目前我正在尝试为我的软件创建一个 swagger 文件。 现在我想为 timeRange 创建一个定义。 我的问题是这个数组看起来像这样: 时间范围: { “2016-01-...

回答 1 投票 0

为什么我无法为这个特定项目生成javadoc?没有错误信息

我正在尝试为我的一些项目生成一些javadoc。评论等已经在里面了,但是当我点击 Eclipse 中的“项目 -> 生成 Javadoc -> ...” javadoc sim...

回答 2 投票 0

如何使用 doxygen 创建公共网络服务器 API 文档?

我想使用 PHP 构建一个 Web 服务器 API,并希望使用 doxygen 为 API 端点生成公共文档。 到目前为止,我知道如何让 doxygen 进入我的内部代码文档......

回答 2 投票 0

用于 MultivaluedMap Jersey 的 Swagger API?可以吗?

是否可以使用Swagger通过Jersey中MultivaluedMap参数的注释来制作API文档? 我有一小段这样的代码: /** * 满足添加 {@...

回答 3 投票 0

缺少 Docu-Sign Cartavi API 文档

不久前,我使用(https://stage.cartavi.com/restapi/swashbuckle/ui/index)来实现几个与 docu-sign 中的房间相关的 API。 目前没有这样的网址,我想知道在哪里......

回答 1 投票 0

是否可以在 RAML 文件中添加重定向链接,例如到另一个 API 版本?

如主题所示,我有两个 RAML 文件,一个与 v1 API 版本相关,第二个属于 v2 API 版本。我的问题是,如果我将我的根 url 和 API 文档传递给某人,我想要...

回答 2 投票 0

如何比较两个 OpenAPI / Swagger json API 文档之间的路径、定义、参数和响应?

我想知道是否有一个解决方案可以帮助查找同一产品的两个不同 API 版本(Swagger/Open API 2.0)之间的差异。比如这个工具:https://gi...

回答 1 投票 0

多个响应正文示例取决于 OpenApi 3.0.0/Swagger 中的媒体类型

我正在尝试记录接受多个 mime 类型请求并根据类型返回不同响应的端点的响应。一种响应类型 PDF 返回其自己的模式分隔...

回答 1 投票 0

通过 swagger 的二进制 API 文档

我正在构建一个能够一次上传多个文件的 API。我需要通过 swagger 来记录它,但我完全没有这方面的经验。 我的 API 架构如下: http 请求...

回答 1 投票 0

是否可以创建多个Swagger文档URL?

我有一个使用 Web API 2 的网站,我正在使用 Swashbuckle Swagger 生成 API 文档并导出 Azure API 管理的 JSON 配置。在我的场景中,它将是 id...

回答 1 投票 0

如何在 swagger 中记录 websocket 事件或回调 [关闭]

我有一个设置,可以使用标准 REST 获取一些资源,这很容易记录在 swagger 中。当相同的资源发生变化时,会使用 websockets 将其推送到客户端,因此

回答 3 投票 0

如何在 C# 中更新 google docs api 命名范围文本?

我想将文本从 C# textbox1 插入到 Google Docs 模板主体namedrange "BoddyTitle" 中,并将文本从 textbox2 插入到主体namedrange "BoddyContent" 。 因为创建的索引

回答 1 投票 0

如何从包含 url 的文件自动生成 REST 端点?

我有一个文件,其中包含必须在 REST API 上公开的 URL。所有 URL 都代表不同的资源,必须单独记录它们。该文件包含数百个 URL,例如: /p1 /p1/p...

回答 3 投票 0

如何生成像sklearn一样的API参考?

为了使我正在编写的Python包更易于使用,我正在考虑制作详细的API文档。 机器学习包 sklearn 的 API 参考是我试图模拟的。 S...

回答 1 投票 0

如何生成这个 Spring-boot API 文档示例?

我正在尝试追踪一个已经离开公司的开发人员是如何生成一些 Java Spring-boot API 的。该文档如下所示: 我们有招摇,但这看起来没什么

回答 1 投票 0

如何验证Flask中的参数

有没有办法验证 Flask 中的刺痛以检查以下内容。我希望它不仅出现在 Swagger 文档中,而且还可以将其捕获为字符串验证错误(如果 pos...

回答 1 投票 0

Grape-Swagger:路由参数问题

我正在使用grape-swagger来显示我正在使用Grape构建的Ruby API的文档。 我正在为端点上的所有参数添加描述,但我似乎找不到任何有关如何...

回答 1 投票 0

ReDoc 是否有类似于 Swagger 编辑器的实时编辑器? [已关闭]

我已经开始使用 ReDoc 来发布我的文档,但在将其推送到我的 Web 服务器之前没有一个好的方法来知道它会是什么样子。我过去使用过 http://editor.swagger.io/ 并且...

回答 1 投票 0

Swagger/OpenAPI 3.0 RequestBody 描述未显示

我正在 Swagger 中创建 API 文档。我直接尝试了openapi 3.0。不知怎的,我无法让我的请求主体的描述发挥作用。 请求正文: 内容: 申请/x-www-form-

回答 1 投票 0

© www.soinside.com 2019 - 2024. All rights reserved.