问题标签 [api-doc]

我想在我的代码中检索方法描述。我使用反射来提取项目中使用的方法的名称（为此使用了 MemberInfo.GetMethod()）。现在，我想获取从该工具中提取的每个方法的描述。实际上，我希望 MSDN 提供 API 参考描述：https ://docs.microsoft.com/en-ca/dotnet/api/?view=netframework-4.7.1 。如果我们将光标放在 VS2015 IDE 中的方法名称上，则会出现此描述，但我想借助编码获得这些描述（类似于使用方法名称的查询，并具有该查询方法的参考描述）。我已经用 Java 和 Python 做到了这一点，但在 C# 中没有找到任何东西。请帮我弄清楚我的问题。

我正在使用 Paw 将我的 api 调用导出到一个 swagger 文档。

“请求”正在正确生成，但不是“响应”。他们都只是说：

默认没有为此操作提供响应描述

如何添加回复？

我的文件示例：

爪子截图：

输出截图：

我在编写视图集和使用django rest docs时尝试记录 API 。我有以下问题：

• 如果我尝试发送反向相关字段的值，它需要值列表，但是在 Form-data 中发送数据时，它以字符串的形式出现。

• 文档 UI 中没有文件上传选项。

以下是我的代码：

模型.py

视图.py

序列化程序.py

我正在使用 http://www.django-rest-framework.org/topics/documenting-your-api/

默认文档中的图像字段中没有文件上传。

谢谢

我已经尝试了 cli apidoc 命令apidoc -i C:/Users/Lenovo -o C:/Users/Lenovo/apidoc，但它们都解决了相同的错误：

请帮忙。

我正在尝试获取此 api 的响应： 这里是 api 的一些文档，
所以当我尝试调用 api 时，控制台会给我以下信息：

但是如果你看到图像的 url 必须是“值”，它是空的，我不知道为什么，这是我的代码：

最难得的是，如果您访问此页面： http ://contextualwebsearch.com/api/Search/ImageSearchAPI?q=donald%20trump&count=10&autoCorrect=true您会找到包含所有信息的 json我正在寻找。

我在设置 Swagger 时遇到了问题。如何在我的 node-express 项目中实现 Swagger 来为现有 API 编写 API Doc？我看过 swagger、swagger-ui 和 swagger-ui-dist npm 包。但没有得到想要的输出。我想使用 Swagger UI，但对配置感到困惑。谁能告诉我配置的分步指南？需要帮忙。

我需要查看 TensorFlow API 文档以获取旧的 TF 版本（0.12.1）。该网站将我指向 GitHub 分支。通过检查相应分支的子包中的代码，我能够找到我的信息。但是，我正在寻找一种有效搜索旧api信息的方法，即使用网站上提供的搜索栏和分层树搜索（网站左侧）等。

有没有更快的方法，如果是这样，除了在这种情况下搜索 .md 和代码文件之外，最好的方法是什么？

Im working on a nodejs server and trying to generate some documentation. as Ive read here:http://apidocjs.com/, Ive added the apidoc as a dependency to the project and ran:npm install everything went well and I do see node_modules/api_doc directory, however I cant seem to run apidoc -i myapp/ -o apidoc/ now I realise that for this to run I need to add to my environment variables the path to the apidoc\bin folder however this dosent make much sense to me as the npm install is only locally to my current project and not globaly for any project I make, what am I missing here and how do I make this work? Thanks in advance.

我不知道为什么这行不通。医生说：

这是我的代码

PowerShell 给我以下错误：@apiParamExample 和 @apiParam 不匹配！参数 'file.bucket' 不存在，以及'file.key'和'file.name'。

在我的 symfony 项目 4.1 上将 nelmio api doc 从 3.0 更新到 3.1/3.3 时出现问题。我无法访问可以在请求中发送到 API 服务的参数，我不明白。不管是用$request->attributes->all()、$request->query->all()还是$request->request->all()，我从来没有我的参数，但是在3.0版本中，它可以工作

我尝试清除缓存，更改参数类型，它不起作用:(

我的 symfony 项目中的 nelmio api doc 包有这个配置

我的控制器中的示例注释：

请问有人有解决办法吗？谢谢 ！