源码编译
方式是注解!swagger-jaxrs提供了很多可供调用的注解方式,方便研发在添加代码生成我们需要的接口信息,请看项目中的使用代码:
swagger-samples项目是为了针对我们的swagger-core的工具,编写的样例,方便大家理解的。里面还有java和scala的项目,目前我们只关注java的。
这个时候你就可以看到利用swagger-core生成的api文档,具体这个界面里面的东西,我会在下一篇swaager-ui的文章来讲解。
针对不同的web框架,提供了多种针对性jar包。
java-jaxrs项目依赖的是swagger-core的swagger-jaxrs项目,由此可以看出swagger-core中的子项目是针对特定框架分开来开发的。而swagger-jaxrs项目针对的是jaxrs技术开发的web项目。那么他是怎么通过你的项目生成api可视文档的呢?
那我们来看看他如何生成这个文档的,或者说如何将代码里的接口呈现在我们眼中的呢?
我将这两个项目的源码都clone到本地,然后编译,以确保正确导入到eclipse中
simaples项目源码编译:
实例
swagger-core含有如下子项目:
具体的注解代表什么意思,有时间我会一一道来的。
我们找一个例子来实际看看swagger-core到底是做什么的?
工作原理
我们来看java-jaxrs项目,按照github上的教程,启动完服务器后,我们在本地访问http://localhost:800打开后如下:
文章为作者独立观点,不代表股票交易接口观点