Java里如何查找第三方包/依赖的api文档

众所周知,要查找第三方包的api介绍说明,在golang里,直接去这个网站搜索即可:https://pkg.go.dev/ ;
在Python里则是去PyPi:https://pypi.org/ (详细方法见此文:https://zhuanlan.zhihu.com/p/78580029)。

可是在Java里,Java官方文档显然并不包含对海量第三方包的说明,且似乎没有统一的用于查找第三方依赖api说明的网站,我们似乎只能通过 https://mvnrepository.com/ 或者 https://search.maven.org/ 这类查找maven依赖的方法获得第三方jar包,但这些网站却并不提供关于这些jar包如何使用的基本说明。但事实上,正规的第三方jar包都会提供文档说明,作为Java新手,我来为初学者介绍自己摸索的关于如何获取第三方依赖使用文档的3种方法。我们以 com.fasterxml.jackson.dataformat:jackson-dataformat-xml 这个依赖 为例。

方法一:使用https://mvnrepository.com/ 搜索到想要的jar包后,我们注意到页面上有个Homapage的选项,打开对应页面,通常是它的Github:
在这里插入图片描述
在Github页面,我们能看到有个 javadoc 文件夹,可以下载下来,
在这里插入图片描述
也可以直接点击这里在线打开:
在这里插入图片描述
如果打不开Github,可以参考这里
https://www.zhihu.com/question/525590687/answer/2686057718,或者参考方法二。

方法二:使用https://nowjava.com/jar/ 输入jar包名称搜索,下载名字最后是javadoc的那个jar包,将后缀从 .jar 换成 .zip,然后解压打开index.html目录即可。
在这里插入图片描述
方法3,有没有办法让Maven在下载jar包时,一起把对应的javadoc也下载了呢?当然可以。例如说,你有个java项目叫mavenProject,那么打开mavenProject目录,在有POM文件的那一级目录下,打开命令行窗口,例如windows的cmd,然后执行下面命令(两个命令根据需要选择),那么maven就会下载当前POM里所有依赖的sources或javadoc的jar包:

mvn dependency:sources  // 让maven去取所有在POM中导入的依赖的sources jar包
mvn dependency:resolve -Dclassifier=javadoc // 让maven去取所有在POM中导入的依赖的javadoc jar包

另外更新几个常用的包的java api文档在线地址:
Java 11中文在线文档:https://www.runoob.com/manual/jdk11api/index.html
Java 11官方英文文档:https://docs.oracle.com/en/java/javase/11/docs/api/index.html
JavaEE api文档:https://docs.oracle.com/javaee/7/api/toc.htm
Tomcat api文档:https://tomcat.apache.org/tomcat-10.0-doc/api/org/apache/catalina/startup/package-summary.html
Spring api文档:https://docs.spring.io/spring-framework/docs/current/javadoc-api/overview-summary.html

  • 4
    点赞
  • 21
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值