phpapi文档生成

❶ phpstorm自动生成方法注释规则配置

首先你得安装好java以及配置好环境变量，能在cmd里面运行java。win+R弹出运行窗口输入cmd回车，进入dos界面，输入java-version，检查java是否配置好。
配置好java后，我们新建一个含有公共类的java文件，在里面随便写点东西。然后保存到文件夹test里面，在文件夹里面空白处，按住shift键，然后点击鼠标右键，出现：在此处打开命令窗口，点击进入命令窗口，然后输入javadoc（空格）DemoA.java，回车，会跳出正在生成api注释文档，我们点击index.html即可查看文档。
PHPSTORM的快速生成注释的方法：设置头部注释、类注释以及函数注释，时间、用户名、文件名称等随机改变的属性，直接使用其下方已经定义的属性即可。生成注释，输入”/**，“按”enter“键即可出现对应注释内容。

❷ 如何使用PhpDocumentor生成文档

命令行方式：
在phpDocumentor所在目录下，输入phpdoc –h会得到一个详细的参数表，其中几个重要的参数如下：
-f 要进行分析的文件名，多个文件用逗号隔开
-d 要分析的目录，多个目录用逗号分割
-t 生成的文档的存放路径
-o 输出的文档格式，结构为输出格式：转换器名：模板目录。
例如：phpdoc -o HTML:frames:earthli -f test.php -t docs
Web界面生成
在新的phpdoc中，除了在命令行下生成文档外，还可以在客户端浏览器上操作生成文档，具体方法是先把PhpDocumentor的内容放在apache目录下使得通过浏览器可以访问到，访问后显示如下的界面：
点击files按钮，选择要处理的php文件或文件夹，还可以通过该指定该界面下的Files to ignore来忽略对某些文件的处理。
然后点击output按钮来选择生成文档的存放路径和格式.
最后点击create，phpdocumentor就会自动开始生成文档了，最下方会显示生成的进度及状态，如果成功，会显示
Total Documentation Time: 1 seconds
done
Operation Completed!!
然后，我们就可以通过查看生成的文档了，如果是pdf格式的，名字默认为documentation.pdf。
给php代码添加规范的注释
PHPDocument是从你的源代码的注释中生成文档，因此在给你的程序做注释的过程，也就是你编制文档的过程。
从这一点上讲，PHPdoc促使你要养成良好的编程习惯，尽量使用规范，清晰文字为你的程序做注释，同时多多少少也避免了事后编制文档和文档的更新不同步的一些问题。
在phpdocumentor中，注释分为文档性注释和非文档性注释。
所谓文档性注释，是那些放在特定关键字前面的多行注释，特定关键字是指能够被phpdoc分析的关键字，例如class，var等，具体的可参加附录1.
那些没有在关键字前面或者不规范的注释就称作非文档性注释，这些注释将不会被phpdoc所分析，也不会出现在你产生的api文当中。

❸ php如何开发API接口

比如一个自定义函数：function test(){echo ‘hello world’;}就可以叫做 api。api 既可以是单个的函数，也可以是封装在类里的方法，当然它们也是程序代码。开发一个 api 的流程可以很简单，也可以很复杂，视具体的编程任务而决定，并没有特定的规则。比如，你需要为自己建立一个常用的函数库，命名为 my.lib.php然后把你自己编写的自定义函数，全部写在这个文件里面，那么，你就拥有了自己的api。开发的时候，只需要引入 my.lib.php，你就可以调用自己的 api 了。这是一个比较简单的例子。稍微复杂一点的，你可以把函数封装在类里面，方便继承和重用，还可以根据函数名称做一些程序设计，这个一句话说不清楚，给一个简单的例子吧：class mylib{function showmy(){echo ‘这是我的一个类方法’;}}调用的时候，先要实例化类，然后再调用方法。再复杂一点的就是使用类接口，区别就是接口里面定义的只是方法原型，而你需要通过具体的类来实现接口中的函数，具体请参考 php 手册

❹ PHP调用API，有对接文档，有KEY，我是新手，不知道怎么写，请高手赐教！

使用curl访问或者file_get_contends访问，

$url = 'http://fire.ym0613.top/api/v1/channel/task/grap?key=&prov=你接单的省份&tid=你得任务id';

$jsons = file_get_contents($url);
$jsons = json_decode($jsons,true);
echo '<pre>';
print_r($jsons);
exit;

❺ 如何生成RestFul Api文档

还是喜欢使用WisdomToolRESTClientV1.1支持自动化测试RESTfulAPI和自动生成RESTfulAPI文档

工具地址：

https://github.com/wisdomtool/rest-client/

❻ 如何生成rest api文档

转载
构建web可访问应用编程接口很简单，但使之良好工作，而且不间断却不简单，Les Hazlewood在2013年JavaOne大会上如此说，他是Stormpath的首席技术官。Hazlewood在大会上展示了通过JAX-RS和Jersey构建美好的REST+JSON API的最佳实践。
“表面看来，良好的REST API很简单，即使后端很复杂，” Hazlewood在一次采访说到。一个API关注一系列的东西，以及如何表现个人的东西。减少API集合，搜索所有书籍和出版刊物，你会发现一个简洁的解决方案，它很直观，且不是太复杂。
在本文中，Hazlewood深入打探讨了API最佳实践、REST API和JSON的优缺点等等。
使用REST API时，什么是开发人员需要探索的？
Les Hazlewood：REST作为架构式构建存在于HTTP的最顶层虎珐港貉蕃股歌瘫攻凯。你交换数据的方式、你创建、读取、更新和删除数据的语义都建立在HTTP规范之内。REST是用于编纂当交换跨分离机器创建读取-删除时的工作环境如何。
这就是REST，编纂这些跨分离机器的行为发生的方式。因为它依赖于HTTP，我可能有一台Linux机器，它可以与Windows机器时行对话，也可以与Mac机对话。它并不是平台或厂商特定的。因为HTTP无处不在，所以REST就无处不在。所有语言（Python、PHP、Java和C#）都可以与REST一起工作。
REST简化了所有方面。所有人都以为他们了解了HTTP。这正是你的浏览器所讲的东西。他们知道HTTP协议、知道GIT、知道POST，因为他们多年以来一直在填写web表单。所以因为REST只使用HTTP，开发人员就认为它很简单，但是现在REST服务越来越多，而不是XML，它融汇的SOAP。
使用REST的难点在哪？
Hazlewood:：这正是我要做的演讲原因。REST是架构样式，但是使用它的方法论还没有正式的标准和规范。用样式来解释一下。我认为它的运行方式可能会与你以为稍微有点不同。因为它不是一个机器可以复制的规范，这里掺入了人为的因素。把东西变得简单易用的漏洞往往都不简单。REST和JOSN很简单。HTTP很简单。但要确保使用两者解决问题时，要直观，而不是随处都可编码化。
你推荐JSON和REST一起使用的其它原因还有什么？
Hazlewood：REST和JSON提供了与人友好的数据表述方法；数据不再像XML那样拥挤；你的肉眼就可以很容易看到。这一直都是广泛采用JSON的原因。
JSON是语法规范。它只是定义了基本的字符串、数字、空值、非空值。它允许你以一种简单的模式表述复杂的事情，而且以最小的元数据量。它如此的篇章，可以用于许多不同的环境中。机器很容易对其进行解析。人们也很容易阅读。
JavaScript是世界上一个占有重要位置的编程语言。即使主要的应用是由Java、Python或C#构建的，比重也很高，如果你有一个网页，或一个可视的用户界面，那么就会涉及到一些JavaScript。JSON与JavaScript兼容。所有具备JavaScript编程经验的人都会发现他们很容易就会了解JSON。如果你已经使用了JavaScript，那就能很轻松地与API集成。如果API返回给JSON，而且你已经编写的JavaScript，那么你的编程语言就已经知道如何与返回给服务器的数据进行交互。JSON使用JavaScript进行数据交换，而不只是编写软件，这在当前已经很流行了，
什么时候使用JSON正确，什么时候错误？
Hazlewood：显然，XML在结构化表述数据上更好。XML文档中包含更多的信息，类型在XML文档中表述会更有效。XML非常适合数据交换，但易用性方面却使用开发者犹豫了。JSON用肉眼就可以检查。XML在设计上更复杂。JSON是非常简单的语法。谈到语言设计，JSON只构建了一小部分的核心元素，而且一切都源于这一小部分元素。因为它的简单性，它很容易操作，也很容易理解。与XML相比，JSON并不是很适合机器消化信息。从这点来看，XML就会做的更好。

❼ phpstrom怎么生成api

windows下按下快捷`Ctrl`+`Shift`+`+`，这样就能恢复打开所有代码了。 这样再单独打开需要查看几个方法就方便多了，

❽ 如何使用go-swagger 生成Api文档

看来你还没理解maven，maven的设计思想之一是”约定优于配置“，最大优势在于”依赖管理“。archetype这个插件里面就是内置了一些app,web-app的类型，maven把他认为的最佳实践都内置好了，你所做的是按照约定把该放的东西放到位置，当然你也可以像你说的把一些代码改地方，你可以仔细研究一下archetype插件的文档中一些参数，不过maven官方不推荐改动，因为大家都遵循差不多的规定，然后在pom.xml里面很简单的就配置好依赖关系，工程的扩展就容易了。maven希望是你把你的工程源代码按照maven建好的目录进行组织即可，如果这些不适合，你可以再看看其他插件里有没有合适的。你要是那样用，还不如用ant，怎么设置工程是活的，maven并不是取代ant，只是它用了另一套哲学。不知道你认同否

❾ api文档怎么写 api接口我已经写好了但时文档不太会写 还有编写api文档有什么作用 请各位高手大虾指点迷津

很多扩展类，框架。PHP有第三方的函数库。DELPHI则是控件。其实这体现了“软件工程”中代码重用的思想。任何好的，工业生产级别的语言都会有很多的扩展支持的。如果，每个体统都需要从底层一点一点的敲代码。是很浪费的。DELPHI整个体系的思想是很优秀的。被很多语言工具借鉴。比如.NET。而且DELPHI是开源的。这些控件，都是优秀的学习资料。 祝你好运

❿ swagger ui 怎么生成php开发的api文档

Swagger --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.2.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version> </dependency> <!-- END Swagger -->这样呢，如果不行的话你可以直接去后盾人线下面授培训问问那些专家讲师，他们很乐意帮你的，希望能帮到你，给个采纳吧谢谢，(ง •̀_•́)ง