问题标签 [api-doc]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
java - Swagger-codegen 重命名同名方法
我已经生成了一个招摇的客户端 api：
但是 swagger-codegen 重命名具有相同名称的方法，尽管它们位于不同的 java 类中。有没有办法解决这个问题？
npm - 警告：请创建一个 apidoc.json 配置文件
我想用apidoc创建API文件，但是在执行apidoc -i xcrm/ -o xcrm/apidoc/命令时提示如下错误：
warn: Please create an apidoc.json configuration file.
info: Nothing to do.
但我apidoc.json在公共目录（我的根目录）下创建了文件。
apidoc 网站是http://apidocjs.com/
postman - 如何将 apiDoc 转换为邮递员收藏？
我有一个 nodejs 项目，其中实现了许多请求并由 apiDoc 进行了详细记录，我想从中创建一个 Postman 集合！
可以从 apiDoc 创建邮递员集合吗？
javascript - Laravel - 忽略子文件夹中的href问题
我在 laravel 忽略的文件夹中遇到了一些麻烦。在我的 .htacces 中，我有一行会忽略我的名为“doc”的文件夹。
并且它应该像它应该的那样工作....有点.. 示例：'localhost/doc/main.js'如果我直接在我的网络浏览器中输入它就可以正常工作。
这是我的问题：在我的 /doc 中，我有一个“index.html”，其中包含/需要/链接来自 doc 目录的一些文件。所以在 index.html 我有一行
当我转到“localhost/doc”时，我收到错误，即找不到文件（以及很多其他文件）。链接到“localhost/vendor/require.min.js”。这应该是'localhost/doc/vendor/require.min.js'
注意：这个文件是用 ApiDocJS 生成的
任何人都可以为我提供解决方案，现在我被困了大约 4 个小时......我很沮丧
php - 在生成的文档中为示例请求设置默认标头值
我正在尝试为我的 api 文档设置示例请求。它工作正常，但我需要为每个请求设置许多标头值
有没有办法为每个示例请求发送的标头定义默认值？
我尝试为标头设置默认值，例如：
此外，我正在考虑在生成的 html 中包含自定义 js 来填充这些字段（我不确定是否可能），但我希望有一个更简单的解决方案。
json - 如何使 apidoc.json 参数成为必需？
超级简单，但是当我标记我的文档以生成 api-doc（使用包@：http ://apidocjs.com ）时，我找不到关于如何根据需要标记参数的文档
...生成以下html：
我希望optional如图所示成为required. 那是什么标记？
laravel - 大摇大摆的 Laravel 5.5
我正在使用"darkaonline/l5-swagger": "^5.5",将 swagger 集成到我的项目中。并完成整个配置步骤。
这是我的功能
我收到了这个错误$ref "#/definitions/Client" not found for @SWG\Items() in \App\Http\Controllers\Api\ClientApiController->index()
node.js - 来自 GitHub Pages 的 API 调用
我使用 ExpressJS 和 MongoDB 创建了一个 ReST API 实现。目前我在 OpenShift 上托管 API。我使用 apiDoc 生成了一个文档，并将文档托管在 GitHub Pages 上。
当我在本地机器上打开文档时，它似乎工作正常，并且我从 OpenShift 上的 API 实例获取内容。但是，当我尝试从托管在 GitHub Pages 上的电话拨打电话时，我收到以下错误：
网址：https ://faxad.github.io/xpress/#api-Inventory-GetItems
如果我将 URL 放在 POSTMAN 中的端点，我得到的结果是好的。
API：http: //xpress-xpress-api.7e14.starter-us-west-2.openshiftapps.com/inventory
为什么当我尝试从 GitHub Pages 访问它时它不起作用？
android - 使用 Android 框架的方法时如何知道可能的响应？
我参考了一个示例代码来练习Android开发，部分代码如下：
我想知道如何知道响应可能是什么？例如，示例代码使用了“ response.optInt("err") != 0 ”，这意味着一个可能的响应是“0”，但是我怎么知道其他可能的响应呢？
我只能参考 API 文档吗？当鼠标悬停在代码上时，是否可以显示弹出 API 文档窗口，看起来像 Eclipse 上的 JavaDoc？
ruby-on-rails - Rails 5 的 API 文档工具
我有一个 API only rails 应用程序，它需要前端开发人员的文档。这是我第一次体验它。
您为此目的使用什么工具？请注意，我使用的是 rails 5 API 而不是 Grape。
我测试了Apipie,swagger-blocks和swagger-docs gems，但它们已经过时或有问题。一定有更好的选择！
尊重任何建议