documentation 相关问题

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

编写 REST API 技术规范的好工具[已关闭]

编写 REST API 技术规范和文档有哪些好的工具?我需要指定 URL、路由、端点。 另一种方法是自动生成 API 文档...

回答 1 投票 0

为API库生成更好的GoDoc

我用Go实现了一个典型的REST API库。但由于端点的数量和不同的数据结构(端点之间几乎没有共享),该项目的 GoDoc 非常

回答 1 投票 0

raml 1.0 响应类型

我正在尝试构建 RAML 文档(v 1.0),但我在第一阶段就陷入了困境。我有供应商资源,我定义如下: 类型: 小贩: 类型:对象

回答 1 投票 0

无法使用apiDocjs生成文档

浏览了一些教程和文档, 包括这里的主要文档。随后创建了两个文件: 示例.js var 当前用户={ 名字='玛丽' }; /** * @api {get} /用户/请求...

回答 1 投票 0

我需要一个文档准备工具来记录我的球衣休息网络服务[已关闭]

我想记录我的球衣网络服务,我的想法是我想记录我们传递给服务的输入数据以及我们传递给服务的参数,所以...

回答 1 投票 0

APIPIE自定义缺失参数消息

我已使用以下 apipie 代码进行操作,但我得到的是标准的“缺少参数 ip_address”,而不是丢失的消息 api :POST, '/addresses.json', "创建一个新地址...

回答 1 投票 0

RAML 文档不显示在 API 控制台中

我在我正在开发的 RAML 规范中定义了以下文档: #%RAML 0.8 标题:API 版本:1.0 基本Uri:http://localhost #==================================================== =============...

回答 1 投票 0

使用 Swagger 的 Spring REST API 文档 [已关闭]

我正在寻找一个可以帮助我生成 RESTful API 文档的工具。我的服务器是用Java编写的并使用Spring MVC框架。我的服务器中没有视图。这是一个 100% RESTful 的服务...

回答 5 投票 0

Swagger 特定路径的安全性

我有一个 Node.js API,我想在其中添加 swagger 文档。客户端通过 JWT 授权,因此我将其添加到安全性中: 安全性定义: 用户安全: 类型:apiKey 描述:我们...

回答 1 投票 0

如何使用yaml在swagger中描述响应对象?

我们有以下 /papers/15 的 JSON 响应 { “数据”: [ { “id”:1, “标题”:“富” }, { “id”:2, &q...

回答 1 投票 0

Grape API(swagger 文档)-“desc”的全局配置

这是有趣而忙碌的一周。我正在开发一个 Rails 项目,并使用 Grape 来实现 API。 API 有 2 个部分 无需身份验证(无标头) 需要身份验证 我设置应用程序...

回答 2 投票 0

有Raml 1.0(不是0.8)HTML 生成器吗? [已关闭]

有人知道是否有 raml2html 到 Raml 1.0 的版本?我只找到了适用于 Raml 0.8 的工具,例如 raml2html 或 raml2md,但不适用于 Raml 1.0。

回答 3 投票 0

微服务的集中式 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

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