问题标签 [api-doc]

对于我的研究，我想知道一些 Java 标准库类的作者，比如Socket。我用openjdk尝试过，但没有那么成功。我想看看哪个作者写了 API 文档的哪个部分。

我正在 Lumen 5.3 中编写一个 API，我想在我的文档中包含APIDoc，我将 APIDoc 文件渲染到 app/API/Docs，并且我希望能够在任何时候从这个文件中渲染 index.html /docs 路由被浏览器上的 Get 请求击中。我怎样才能在流明中实现这一点？

我创建了一个 Swagger 文档，其中包含以下yaml文件：

现在我想分享一个带有其定义的静态 HTML 文档，但在swagger 项目中声明，他们根本不打算支持 HTML 生成。

如何从 Swagger 项目生成静态 HTML 文件？

我在 Sails.js 应用程序中使用apiDoc文档。而且，上周我看到有人在一个名为api_definitions.js的文件中定义了多个控制器使用的响应

例子

并且，在每个控制器中，使用正常的Use Parameter @apiUse UserSuccessExample引用它。但是当我尝试它时，我在控制台中收到一个错误，说它没有定义：

错误

我使用 Nelmio 自动生成我的 api 文档。我想在 responseMap 中返回一个对象，它是一个简单的类（没有关联数据库的实体），如下所示：

但是我的 api 文档中没有显示响应对象。谁能帮我 ？谢谢。

我有一个 Tornado Web 服务器，它在其 API 中公开了一些端点。我希望能够在代码中记录我的处理程序（端点） ，包括描述、参数、示例、响应结构等，然后生成一个交互式文档，使人们能够“玩”我的 API，轻松地发出请求和在沙盒环境中体验响应。

我知道Swagger，尤其是他们的 SwaggerUI 解决方案是最好的工具之一，但我对它的工作原理感到困惑。我知道我需要为 SwaggerUI 引擎提供一些.yaml定义我的 API 的内容，但是如何从我的代码中生成它？我发现很多 github 库都不够好或者只支持 Flask...

谢谢

我使用apidoc library为我的 Django 应用程序创建了文档。它使用 Angular 创建文档。应用程序正在 Heroku 上运行。

当我打开文件时，文档运行良好index.html，但我无法通过http://localhost:5000/docs打开它们。

首先我得到了这个错误：

“变量和属性可能不以下划线开头：'__'”，我可以通过将 {% verbatim %} 和 {% endverbatim %} 放入 index.html 文件来绕过它。（我一开始不太满意，想以其他方式做到这一点）。

然后页面卡在加载屏幕上，但是当我在 Chrome 中打开它时，出现以下错误：

polyfill.js:1 和 require.min.js:1 中的“Uncaught SyntaxError: Unexpected token <”

还有3个警告：

“资源解释为样式表，但使用 MIME 类型 text/html 传输”

在 vendor/bootstrap.min.cs、vendor/prettify.css 和 css/style.css

我们也在其他带有 Node 的项目中使用 apidocs，它运行良好，所以我认为这是 Django 的问题。由于文档是自动生成的，我更愿意将更改引入应用程序，而不是文档。我在 Chrome 和 Safari 上试过。

我的问题 1. 我该怎么做才能让它发挥作用？2. 如何在不添加 {%verbatim%} 标签的情况下使 Django 与 Angular 兼容index.html？

这是我的控制器：

和 url_pattern：

index.html头：

编辑：感谢休伯特的回答，我能够找到问题的根源。事实证明，Django 不能很好地与 api 文档使用的 RequireJS 一起工作。

我必须在生成的代码中添加以下更改才能使其工作：第 1-4 点用于 index.html，第 5、6 点用于 main.js：

1. 在标签上方添加这一行：

{% load static %}

2. 将“{% static”+“%}”标签添加到所有标签，如下所示：

<link href="{% static "vendor/bootstrap.min.css" %}" rel="stylesheet" media="screen">

3. 使用 polyfill.js 和 require.min.js 将相同的静态标签添加到标签中：

<script src="{% static "vendor/polyfill.js" %}"></script> <script data-main="{% static "main.js" %}" src="{% static "vendor/require.min.js" %}"></script>

4. 在开头添加 {% verbatim %} 并在末尾添加 {% endverbatim %} ，但在 require.min.js 之前！

5. 在 main.js 中，将以下行添加到文件开头的路径中：

apiProject: './api_project.js', apiData: './api_data.js',

6. 换行：

'./api_project.js', './api_data.js',

至：

'api_project', 'api_data',

我尝试在没有弹簧启动的情况下通过 swagger 生成一些 api，但它不起作用

我的招摇控制器类

网址已映射

但是文档没有创建我错过了什么吗？可能我可以在服务器上使用 SpringBoot 吗？

我编写了一些代码用于将数据发送到其他 url，这些代码是用 spring 和 java 编写的，使用“httpclient”类。关于该代码，请检查我提出的这个问题

如何获取http状态值？

我对http的请求和响应有问题，这已经解决了。我的问题是关于 http 状态的，最后我得到了请求不带有状态值的事实。

无论如何，所以我必须为我们的代码制作一些文件以向客户展示，我对响应选项卡感到困惑。

我写的是回应：

我的团队经理想要这样的回应：

我是对的还是我的老板是对的？但是当我想，如果请求没有携带http状态值，我怎么能像我的团队经理说的那样写呢？或者我怎么能写那一面？

apiary.io 可以用作纯私有的本地解决方案，而不是提供的托管解决方案吗？