Swagger2构建Java项目api文档的正确用法

基础的用法

怎么接入,怎么配置,网上的教程一大堆,我也就不赘述了,本文主要探讨一下其他的进阶用法,怎么直接用写的注释(注意不是注解)来构建文档,这在为老项目生成文档时很有用。

我都写了注释了,为什么还要写文档

要解决这个问题,一般只用在接口和实体上加上swagger提供的注解就行了,这也是基本用法里说过的,我也就不详细说了,因为我也不用这种方式。

我都写了注释了,为什么还要写注解

我的看法swagger提供一套文档注解并不是最优的解法,因为这会让老项目迁移很吃力,要加很多注解。
作为一个懒人,通过调试跟踪,发现他是在ModelMapper.mapModels实现对Model对象的获取的,我们只要重写这个方法即可实现。ModelMapperImpl类是他的默认实现,什么也没有做,我们不妨继承他来重写哪个方法。

如何获取注释

可以直接写一套解析java文件的代码,也可以直接用现成的包,比如这个jboss的包,一般java服务器相关的包都有类似的方法。

        <dependency>
            <groupId>org.jboss.forge.roaster</groupId>
            <artifactId>roaster-api</artifactId>
            <version>2.21.1.Final</version>
        </dependency>
        <dependency>
            <groupId>org.jboss.forge.roaster</groupId>
            <artifactId>roaster-jdt</artifactId>
            <version>2.21.1.Final</version>
        </dependency>

部署在服务器上没有源代码怎么解

能获取到java文件一般也是在本地测试才有,部署在服务器上都是编译后的class文件,没有注释,也不可能将源代码直接放到部署的机器上,我推荐直接在本地获取的时候序列化需要的数据到文件,直接丢在服务器上即可。

代码呢?代码呢?代码呢?

  • 笔者已经贴心的将项目做成的starter,欢迎fork,大家积极提PR,一起完善!

GITEE上源码链接

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容