生成api文档的方法，生成自己的API文档的两种方法

参数信息：

@author 作者名

@version 版本号

@since 指明需要最早使用的jdk版本

@param 参数名

@return 返回值情况

@throw 异常抛出情况

方法一

打开文件所在位置，在系统索引中加入cmd进入命令行模式，通过在命令行中输入 javadoc +参数+ java类名生成api文档。

方法二

在idea中双击shift输入javadoc弹出此页面

将所需要的内容勾选好，并且在Other command line arguments中输入

-encoding UTF-8 -charset UTF-8 来防止出现乱码。

最后点击确定即可生成api文档。

1.Slate

Slate是一款出色的工具，可帮助您创建响应式、智能且美观的API文档。它具有简洁直观的设计，并从 PayPal 和 Stripe 的 API 文档中汲取灵感。它在左侧组织文档，而在右侧编码示例，这在智能手机、平板电脑和印刷品上看起来非常酷且可读。

使用 Slate，您不必在无休止的页面中搜索信息，因为它将所有内容都放在一个页面上，而不会牺牲可链接性。链接到文档中的特定点永远不会有压力，因为当有人滚动时，哈希会更新到最近的标题。

这里写的一切都在 Markdown 中，包括代码块，使您更容易编辑和更清楚地理解事物。Slate 允许您用不同的语言编写代码并在代码块的顶部指定其名称。

Slate 允许以 100 多种语言突出显示独特的语法，而无需对其进行配置。它可以让您建立一个可平滑滚动的自动目录，您可以将其添加到页面的最左侧。Slate 的性能也非常适合大型文档。

Slate 生成的 API 文档默认托管在 GitHub 中。这意味着您可以使用 GitHub 页面免费托管整个文档。

Slate 还为阿拉伯语、希伯来语、波斯语等语言提供 RTL(从右到左)支持。按绿色按钮 - “使用此模板”，然后按照给定的说明操作，即可轻松开始使用 Slate。

2.NelmioApiDocBundle

使用NelmioApiDocBundle为 API 生成看起来不错的文档。该包支持 PHP、Twig、CSS 等语言。NelmioApiDocBundle 允许您以 OpenAPI 格式的版本 2 为您的 API 生成文档，并提供一个沙箱来与您的 API 进行交互实验。

该包支持 PHP 注释、Swagger-PHP 注释、Symfony 路由需求和 FOSRestBundle 注释。对于模型，NelmioApiDocBundle 支持 JMS 序列化器、Symfony 序列化器、willdurand/Hateoas 库和 Symfony 形式。

3.Swagger

如果您身边有Swagger，请忘记手动 API 文档。它提供了广泛的令人印象深刻的解决方案，用于创建和可视化您的 API 文档以及维护它们，以便它们随着 API 的发展而保持最新状态。

您可以从 API 定义自动生成文档。如果您当前的 API 不包含定义，它们会提供开源 Swagger Inflector，因此您甚至可以在运行时生成 OpenAPI 定义。为了加快整个过程，您可以使用 Swagger Inspector 自动为端点创建 OpenAPI 文件。

您可以使用 SwaggerHub 的版本控制系统维护文档的多个版本。

根据标准规范扩展 API 设计和建模，并以您想要的任何语言为 API 构建可重用且稳定的代码。借助 Swagger，您可以使用他们的交互式文档流程增强开发人员体验，无开销地执行功能测试，并为 API 架构设置和实施样式指南。

3.自述文件

自述文件提供了一种简单的方法来生成和管理交互式和精美的 API 文档。您可以轻松地直接将 API 密钥合并到文档中，自动生成代码示例，并进行实际的 APU 调用而不会混淆。

通过回答您在他们的支持论坛中看到的问题来建立一个强大的社区，允许消费者提出一些编辑建议，并使每个人都了解更改。使用编辑器同步 Swagger 文件、合并建议的编辑并更新内容，以确保您的文档始终得到更新。

自述文件允许您拖放内容;您还可以通过 CSS 自定义所有内容。Markdown Editor、Swagger File Import 和 Theme Builder 是人们喜欢 ReadMe 的众多功能中的一部分。

它甚至允许用户进行 API 调用，然后复制粘贴实际的代码示例。此外，API 日志、API 定义、API Playground 和动态代码片段还有一些其他内容，它们允许您制作参考指南。

自述文件使与您的团队的协作更具互动性，因为他们可以使用版本控制快速建议编辑以保持事物整洁。通过论坛式支持收集客户反馈并认真对待，从而提供出色的客户支持。

5.Widdershins

Widdershins可帮助您根据 OpenAPI 3.0、Semoasa、Swagger 2.0 和 AsyncAPI 1.x 定义创建文档。最新版本中引入了一些更改，包括“承诺”而不是回调，以及直接输出 HTML 和 ReSpec 格式的选项。

Widdershins 使用模板来创建 Markdown 输出，您可以自定义这些模板或将它们复制到特定文件夹。

6.Postman

如果您听说过API，您可能没有听说过 Postman 。

Postman的 API 文档是一个不错的选择，您可以生成即使是机器也能很好阅读的文档。每次实时更改时，它还可以自动使您的 API 保持最新状态，并让您轻松快速地发布文档。

Postman 可以自动提取您的整个示例请求、代码片段、标题等，以使用机器可读的指令和动态示例填充文档。因此，与您想要的任何人共享 API 变得很容易。

通过在您的文档或网站中嵌入按钮“在 Postman 中运行”，可在几秒钟内分享您的所有收藏。这样，任何人都可以通过单击导入文档。通过让您的文档可供任何人使用，包括开发人员、产品经理、测试人员等，从而更广泛地采用 API。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。