七叶笔记 » java编程 » Quarkus集成open api接口使用swagger ui展示

Quarkus集成open api接口使用swagger ui展示

添加完以上依赖后,在开发和测试环境会自动激活组件,并注册/openapi接口,通过这个接口可以获取Openapiv3文档,请求http://localhost:8080/openapi即可。同时也会注册/swagger-ui接口,访问http://localhost:8080/swagger-ui就可以看到如下的界面:

默认情况下,swagger ui只会在开发测试环境激活,如果你想在生产环境也使用swagger-ui,需要在application.properties中添加quarkus.swagger-ui.always-include=true来激活,这个配置是编译时生效的,编译完成后无法更改。前面已经说过,Quarkus集成了open api导出接口数据使用swagger ui展示的,所有集成起来非常简单,下面看下如何使用open api的java规范注解详细的描述接口信息

应用基础信息定义

openapi中使用@OpenAPIDefinition描述应用基础信息,可以类比swagger中的@SwaggerDefinition注解

效果如下:

接口信息定义

效果如下:

传输实体定义

效果如下:

结语

在Quarkus中使用swagger ui,OpenApi v3变成了主角。swagger ui单纯的变成了展示OpenApi v3数据的ui。所以使用方式上也区别了在spring环境中使用的方式,那些熟悉的swagger ui本身定义的注解都没有了,需要重新学习microprofile-open-api中定义的注解了,好在注解变化不大,学习起来没啥难度

以上就是Quarkus集成open api接口使用swagger ui展示的详细内容,更多关于Quarkus集成open api展示swagger ui的资料请关注七叶笔记其它相关文章!

相关文章