Java项目怎么使用Swagger生成API文档？ - 知乎62被浏览26331分享邀请回答01 条评论分享收藏感谢收起&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&
三、配置设置了一些默认显示的api相关信息，最后上截图的时就可以比较清楚的看到。@Configuration
@EnableSwagger2
public class Swagger2Config {
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.apis(RequestHandlerSelectors.basePackage("info.xiaomo.website"))
.paths(PathSelectors.any())
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot中使用Swagger2构建RESTful APIs")
.description("api根地址：:8080/")
.termsOfServiceUrl("/")
.contact("小莫")
.version("1.0")
四、相关注解解读1. @Api用在类上，说明该类的作用@Api(value = "UserController", description = "用户相关api")2. @ApiOperation用在方法上，说明方法的作用@ApiOperation(value = "查找用户", notes = "查找用户", httpMethod = "GET", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)3 @ApiImplicitParams用在方法上包含一组参数说明4. @ApiImplicitParam用在@ApiImplicitParams注解中，指定一个请求参数的各个方面paramType：参数放在哪个地方header–&请求参数的获取：@RequestHeaderquery–&请求参数的获取：@RequestParampath（用于restful接口）–&请求参数的获取：@PathVariablebody（不常用）form（不常用）name：参数名dataType：参数类型required：参数是否必须传value：参数的意思defaultValue：参数的默认值@ApiImplicitParams({
@ApiImplicitParam(name = "id", value = "唯一id", required = true, dataType = "Long", paramType = "path"),
5. @ApiResponses用于表示一组响应6. @ApiResponse用在@ApiResponses中，一般用于表达一个错误的响应信息code：数字，例如400message：信息，例如”请求参数没填好”response：抛出异常的类@ApiResponses(value = {
@ApiResponse(code = 400, message = "No Name Provided")
7. @ApiModel描述一个Model的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）@ApiModel(value = "用户实体类")8. @ApiModelProperty描述一个model的属性@ApiModelProperty(value = "登录用户")五、 和Swagger UI的集成首先，从github
上下载Swagger-UI, 把该项目dist目录下的内容拷贝到项目的resources的目录public下。六、访问 就可以看到效果如下七、 项目实例77 条评论分享收藏感谢收起查看更多回答怎么通过 javadoc 命令从文档注释中提取内容，生成程序的 API 帮助文档？
看：被注释的代码块在程序运行时是不会被执行的~~我们可以通过 javadoc 命令从文档注释中提取内容，生成程序的 API 帮助文档。打开首页，查看下生成的 API 文档PS：使用文档注释时还可以使用 javadoc 标记，生成更详细的文档信息：
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向，也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明这一整段都没看明白什么意思，求详细讲解？ 怎么通过 javadoc 命令从文档注释中提取内容，生成程序的 API 帮助文档？不知道操作
如果使用java -d doc 命令会报unrecognized的错误，使用javadoc -d doc这样的命令的话会报未指定程序包或类，所以-d不能直接创建目录。然后，javadoc doc Demo03.java 命令，是在Demo03.java 同一文件夹下生成一份文档。而java -d doc Demo03.java 则是在Demo03.java 所在文件下创建一个名为的doc文件夹，生成的javadoc文档将会放在doc下。
你还没有登录，请先登录或注册慕课网帐号
生成文档注释时，他回去找你代码里的注释
你还没有登录，请先登录或注册慕课网帐号
汗，这是你需要在类定义的注释里写的
你还没有登录，请先登录或注册慕课网帐号
72853人关注
Copyright (C)
All Rights Reserved | 京ICP备 号-2怎样利用javadoc工具生成java程序的API文档
1.什么是API文档
开发一个大型软件的时候，需要定义成千上万的类，而且需要很多人参与开发。每个人都开发了一些类，并在类里定义了一些方法、属性提供给其他人，但是其他人怎么知道如何使用这些类和方法呢？这时就需要一份说明文档，用于说明每个类每个方法的用途，当其他人使用一个类或方法的时候，他无需知道这个类或方法的具体实现，他只要知道这个类或方法的功能即可，然后使用这个类或方法实现据具体的目的，也就是通过调用应用程序接口来编程。API文档就是用来说明这些应用程序接口的文档。
2.如何生成API文档
要生成API文档，就不得不提到注释，在Java中有单行注释多行注释和文档注释三种，文档注释用于生成API文档。
javadoc工具只处理文档源文件在类 接口& 方法& 属性
构造器和内部类之前的注释，忽略其他地方的文档注释，而且，只处理以public，protected修饰的。如果确实希望提取private修饰的内容，可以在石油javadoc工具时增加-private选项。
文档注释：以结束，中间部分全部都是文档注释，会被提取到API文档中。使用javadoc工具来提取程序中的文档注释来生成API文档，javadoc命令的基本用户如下：
javadoc 选项 java源文件/包
选项：-d &路径&指定一个路径，用于将生成的API文档放到指定的目录下。
&&&&&&&&&&
-windowtitle 用于设置API文档的浏览器窗口标题
-doctitle指定一个HTML格式的文本，用于指定概述页面的标题
-header指定一个HTML格式的文本，包含每个页面的页眉
除此之外，javadoc还包含了大量其他选项，可通过执行javadoc -help来查看javadoc命令的所有选项
3.生成一个简单的API文档
在java文件所在路径执行命令：javadoc -d apidoc -windowtitle
我的测试api文档& -doctitle 学习javadoc工具的测试api文档 -header
自定义类 Test*.java
执行完上述命令，进入到java文件所在路径将可以看到一个apidoc文件夹，该文件夹下就是刚刚生成的API文档。进入apidoc路径下，打开index,heml文件，将可以看到所生成的API文档详情。
4.利用javadoc工具生成详细的文档信息
已投稿到：
以上网友发言只代表其个人观点，不代表新浪网的观点或立场。这句话什么意思：我们可以通过 javadoc 命令从文档注释中提取内容，生成程序的 API 帮助文档。
这里说的“从文档注释中提取内容”指的是什么？文档注释中的author,version两个内容也没有被提取啊？
加@在API中不显示了。比如@author 慕课网。执行生成的API中就不会看到有慕课网这三个字。但是如果是不加@，直接在文档注释里面写成author 慕课网，执行生成的API就会看到 author 慕课网。这是怎么回事？
写下你的评论...
写下你的评论...
Copyright (C)
All Rights Reserved | 京ICP备 号-2博客访问： 88044
博文数量： 39
注册时间：
ITPUB论坛APP
ITPUB论坛APP
APP发帖 享双倍积分
IT168企业级官微
微信号：IT168qiye
系统架构师大会
微信号：SACC2013
分类： Java技术
上一篇介绍了如何给一个类通过注释生成java api doc 样式的说明文档，
下面给介绍给几个包里的所有文件，生成注释的方法。
1. 先 cd 到 package 的上一层目录
cd&F:\KQ\java_ecli_workspaces\workspaces\Bach\Crazy_Java\src\com\std\crazy
&11:04 & &&DIR& & & & & &.
&11:04 & &&DIR& & & & & &..
&11:31 & &&DIR& & & & & &collection
&08:24 & &&DIR& & & & & &dtnum
&16:03 & &&DIR& & & & & &mysql
&09:25 & &&DIR& & & & & &reflect
&11:05 & &&DIR& & & & & &teach
& & & & & & & &0 个文件 & & & & & & &0 字节
& & & & & & & &7 个目录 78,531,444,736 可用字节
2. 直接使用javadoc 后面跟包名出错
提示找不到teach的源文件
F:\KQ\java_ecli_workspaces\workspaces\Bach\Crazy_Java\src\com\std\crazy&javado
c -d F:\KQ\java_ecli_workspaces\apidoc -windowtitle 学生管理系统 -doctitle jav
adoc学生管理API文档 -header 我的类 -version -author teach
正在加载程序包teach的源文件...
正在构造 Javadoc 信息...
javadoc: 警告 - 没有程序包teach的源文件
javadoc: 错误 - 找不到可以文档化的公共或受保护的类。
3. 使用*.java可以不报错
F:\KQ\java_ecli_workspaces\workspaces\Bach\Crazy_Java\src\com\std\crazy&javado
c -d F:\KQ\java_ecli_workspaces\apidoc -windowtitle 学生管理系统 -doctitle jav
adoc学生管理API文档 -header 我的类 -version -author teach\*.java
正在加载源文件teach\Teacher.java...
正在构造 Javadoc 信息...
标准 Doclet 版本 1.7.0_51
正在构建所有程序包和类的树...
正在生成F:\KQ\java_ecli_workspaces\apidoc\com\std\crazy\teach\Teacher.html...
正在生成F:\KQ\java_ecli_workspaces\apidoc\com\std\crazy\teach\package-frame.ht
正在生成F:\KQ\java_ecli_workspaces\apidoc\com\std\crazy\teach\package-summary.
正在生成F:\KQ\java_ecli_workspaces\apidoc\com\std\crazy\teach\package-tree.htm
正在生成F:\KQ\java_ecli_workspaces\apidoc\constant-values.html...
正在构建所有程序包和类的索引...
正在生成F:\KQ\java_ecli_workspaces\apidoc\overview-tree.html...
正在生成F:\KQ\java_ecli_workspaces\apidoc\index-all.html...
正在生成F:\KQ\java_ecli_workspaces\apidoc\deprecated-list.html...
正在构建所有类的索引...
正在生成F:\KQ\java_ecli_workspaces\apidoc\allclasses-frame.html...
正在生成F:\KQ\java_ecli_workspaces\apidoc\allclasses-noframe.html...
正在生成F:\KQ\java_ecli_workspaces\apidoc\index.html...
正在生成F:\KQ\java_ecli_workspaces\apidoc\help-doc.html...
3. 生成的效果图
阅读(137) | 评论(0) | 转发(0) |
相关热门文章
学习Timer类，定制自己的调度...
给主人留下些什么吧！~~
请登录后评论。}