blocks|key|2008699|text|你试过apidocjs了吗？|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|2008700|很好地记录API，这很容易，因为我们需要做的只是对代码进行注释。这是一个例子。/**+*+@api+{get}+/:+ID请求用户信息*+@apiName+*+@apiGroup用户**+@apiParam+{Number}+id用户唯一ID。**+@apiSuccess+{String}该用户的名首名。*+@apiSuccess+{String}用户的lastname。*/示例在腔骨架上，您可以将注释放在控制器app/Http/Controllers/UserController@create上。@指控制器内的函数。使用此命令生成docs+-i应用程序/Http/Controller+-o公共/docs|unordered-list-item|style|CODE|2008701|关于API+(当前用户指南)的基本信息是的，请转到尖端示例。|2008702|如何使用API见上面的示例。|2008703|在实现之前测试API它有一个有趣的特性，请检查@apiSampleRequest。但是，如果您的意思是测试是单元测试或功能测试，则apidocjs不支持。|entityMap|0|LINK|mutability|MUTABLE|url|http://apidocjs.com/|1|https://lumen.laravel.com/docs/5.2/controllers|2|http://apidocjs.com/example/^0|3|8|0|0|5S|16|70|1|5C|3|1|0|P|4|2|0|0|N|H^^$0|@$1|2|3|4|5|6|7|Z|8|@]|9|@$A|10|B|11|1|12]]|C|$]]|$1|D|3|E|5|F|7|13|8|@$A|14|B|15|G|H]|$A|16|B|17|G|H]]|9|@$A|18|B|19|1|1A]]|C|$]]|$1|I|3|J|5|F|7|1B|8|@]|9|@$A|1C|B|1D|1|1E]]|C|$]]|$1|K|3|L|5|F|7|1F|8|@]|9|@]|C|$]]|$1|M|3|N|5|F|7|1G|8|@$A|1H|B|1I|G|H]]|9|@]|C|$]]]|O|$P|$5|Q|R|S|C|$T|U]]|V|$5|Q|R|S|C|$T|W]]|X|$5|Q|R|S|C|$T|Y]]]]

Have you tried <a href="http://apidocjs.com/" rel="nofollow noreferrer">apidocjs</a> ?

<ul>
<li>Documenting APIs

Well, it quite easy, because what we need to do is just commenting on our code. This is an example.

<blockquote>
<pre><code>/**
 * @api {get} /user/:id Request User information
 * @apiName GetUser
 * @apiGroup User
 *
 * @apiParam {Number} id Users unique ID.
 *
 * @apiSuccess {String} firstname Firstname of the User.
 * @apiSuccess {String} lastname Lastname of the User.
 */
</code></pre>
</blockquote>

Example on <a href="https://lumen.laravel.com/docs/5.2/controllers" rel="nofollow noreferrer">Lumen Framework</a>, you can put the comment on Controllers <code>app/Http/Controllers/UserController@create</code>. <code>@</code> refer to function inside the controller.

Use this command to generate the doc

<blockquote>
 apidoc -i app/Http/Controllers -o public/docs
</blockquote></li>
<li>Basic information on API (current user guide)

Yes, please go to <a href="http://apidocjs.com/example/" rel="nofollow noreferrer">apidocjs example</a>.</li>
<li>How to use APIs

See above example.</li>
<li>Test APIs before implementation

It has an interesting feature, check <code>@apiSampleRequest</code>. But if you mean Test is Unit Testing or Functional Testing, apidocjs not support.</li>
</ul>

Before during, and even after Web Services implementation, an up-to-date user guide is very important to our customers. I am trying to find an API tool for Restful Web Services which can produce a user-friendly document / user guide in either WORD or PDF format. Is there any suggestions? 

Key points include:

<ul>
<li>Documenting APIs</li>
<li>Basic information on API (current user guide)</li>
<li>How to use APIs</li>
<li>Test APIs before implementation</li>
</ul>

Restful Web Services api documentation tool

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

教程

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云智能顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云AI代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

功能1上新10个字符

功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符。

功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符。

功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符

功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符

功能4上新

文章&问答评论现已支持表情

全新交互，全新视觉，新增快捷键、悬浮工具栏、高亮块等功能并同时优化现有功能，全面提升创作效率和体验

社区富文本编辑器全新改版！诚邀体验～ 

精选全网热门MCP server，让你的AI更好用 🚀

💥开发者 MCP广场重磅上线！

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

聚焦“写作效率、视觉美观与运行性能”三方面进行全面升级，为您提供更高效、稳定的创作环境

社区富文本&Markdown编辑器全新改版上线，欢迎大家体验!

诚挚邀请您参与本次调研，分享您的真实使用感受与建议。您的反馈至关重要，感谢您的支持与参与！

社区新版编辑器体验调研

在Web实现之前，甚至之后，最新的用户指南对我们的客户都是非常重要的。我试图找到一个用于的API工具，它可以以WORD或PDF格式生成一个用户友好的文档/用户指南。有什么建议吗？要点包括：记录APIAPI的基本信息(当前用户指南)如何使用API在实现之前测试API

问文档工具
EN

回答 1

Software Recommendation用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问文档工具EN