Camel - Rest Component 集成 Swagger UI

2024-04-25 18:32

本文主要是介绍Camel - Rest Component 集成 Swagger UI,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

Camel - Rest Component 集成 Swagger UI

  • 1. Spring boot 集成 Swagger UI
    • 1.1 pom配置
    • 1.2 访问swagger ui
  • 2. Camel配置并启用Rest服务
    • 2.1 pom配置
    • 2.2 配置并启动jetty服务
    • 2.3 启动并获取swagger api信息
  • 3. 测试
  • 参考

1. Spring boot 集成 Swagger UI

1.1 pom配置

本示例通过webjar的方式集成swagger UI。
swagger-ui版本为2.2.10.

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><version>2.3.5.RELEASE</version>
</dependency>
<dependency><groupId>org.webjars</groupId><artifactId>swagger-ui</artifactId><version>2.2.10</version>
</dependency>
<dependency><groupId>org.webjars</groupId><artifactId>webjars-locator</artifactId><version>0.40</version>
</dependency>

配置spring boot 默认启动 tomcat 服务器,启动端口配置为 8088

server.port=8088

1.2 访问swagger ui

http://localhost:8088/webjars/swagger-ui/index.html#/
在这里插入图片描述

2. Camel配置并启用Rest服务

2.1 pom配置

<!-- camel -->
<dependency><groupId>org.apache.camel.springboot</groupId><artifactId>camel-spring-boot-starter</artifactId><version>3.6.0</version>
</dependency>
<dependency><groupId>org.apache.camel.springboot</groupId><artifactId>camel-jetty-starter</artifactId><version>3.6.0</version>
</dependency>
<dependency><groupId>org.apache.camel</groupId><artifactId>camel-swagger-java</artifactId><version>3.6.0</version>
</dependency>

2.2 配置并启动jetty服务

配置jetty服务,端口为8080,同时支持 swagger api 服务。
代码参考 https://github.com/ttyy1112/Camel-In-Action-3.3.0/tree/master/spring-app/rest-camel-springboot-test

public class OrderRoute extends RouteBuilder {@Overridepublic void configure() throws Exception {restConfiguration().component("jetty").port(8080)//Enable swagger endpoint..apiContextPath("/swagger") //swagger endpoint path.apiContextRouteId("swagger") //id of route providing the swagger endpoint//Swagger properties.contextPath("/api") //base.path swagger property; use the mapping path set for CamelServlet.apiProperty("api.title", "Swagger UI with Apache Camel-Jetty").apiProperty("api.version", "1.0").apiProperty("api.contact.name", "ATang").apiProperty("api.contact.email", "ATang@atang.com").apiProperty("api.contact.url", "https://atang.com/").apiProperty("host", "") //by default 0.0.0.0.apiProperty("port", "8080").apiProperty("schemes", "").apiProperty("cors", "true");// rest services under the orders context-pathrest("/orders")// need to specify the POJO types the binding is using (otherwise json binding defaults to Map based).get("{id}").outType(Order.class).to("bean:orderService?method=getOrder(${header.id})")// need to specify the POJO types the binding is using (otherwise json binding defaults to Map based).post().type(Order.class).to("bean:orderService?method=createOrder")// need to specify the POJO types the binding is using (otherwise json binding defaults to Map based).put().type(Order.class).to("bean:orderService?method=updateOrder").delete("{id}").to("bean:orderService?method=cancelOrder(${header.id})");}
}

2.3 启动并获取swagger api信息

通过访问 http://localhost:8080/api/swagger ,可以获取swagger api信息。
在这里插入图片描述

3. 测试

在这里插入图片描述

参考

Integrate Swagger with Apache Camel-Servlet.
Spring Boot, Apache Camel, and Swagger UI
SWAGGER JAVA
集成Open API
Swagger技术(接口文档实时动态生成工具)

这篇关于Camel - Rest Component 集成 Swagger UI的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/935463

相关文章

SpringBoot集成XXL-JOB实现任务管理全流程

《SpringBoot集成XXL-JOB实现任务管理全流程》XXL-JOB是一款轻量级分布式任务调度平台,功能丰富、界面简洁、易于扩展,本文介绍如何通过SpringBoot项目,使用RestTempl... 目录一、前言二、项目结构简述三、Maven 依赖四、Controller 代码详解五、Service

springboot2.1.3 hystrix集成及hystrix-dashboard监控详解

《springboot2.1.3hystrix集成及hystrix-dashboard监控详解》Hystrix是Netflix开源的微服务容错工具,通过线程池隔离和熔断机制防止服务崩溃,支持降级、监... 目录Hystrix是Netflix开源技术www.chinasem.cn栈中的又一员猛将Hystrix熔

MyBatis-Plus 与 Spring Boot 集成原理实战示例

《MyBatis-Plus与SpringBoot集成原理实战示例》MyBatis-Plus通过自动配置与核心组件集成SpringBoot实现零配置,提供分页、逻辑删除等插件化功能,增强MyBa... 目录 一、MyBATis-Plus 简介 二、集成方式(Spring Boot)1. 引入依赖 三、核心机制

SpringBoot集成P6Spy的实现示例

《SpringBoot集成P6Spy的实现示例》本文主要介绍了SpringBoot集成P6Spy的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面... 目录本节目标P6Spy简介抛出问题集成P6Spy1. SpringBoot三板斧之加入依赖2. 修改

springboot项目中集成shiro+jwt完整实例代码

《springboot项目中集成shiro+jwt完整实例代码》本文详细介绍如何在项目中集成Shiro和JWT,实现用户登录校验、token携带及接口权限管理,涉及自定义Realm、ModularRe... 目录简介目的需要的jar集成过程1.配置shiro2.创建自定义Realm2.1 LoginReal

SpringBoot集成Shiro+JWT(Hutool)完整代码示例

《SpringBoot集成Shiro+JWT(Hutool)完整代码示例》ApacheShiro是一个强大且易用的Java安全框架,提供了认证、授权、加密和会话管理功能,在现代应用开发中,Shiro因... 目录一、背景介绍1.1 为什么使用Shiro?1.2 为什么需要双Token?二、技术栈组成三、环境

Java 与 LibreOffice 集成开发指南(环境搭建及代码示例)

《Java与LibreOffice集成开发指南(环境搭建及代码示例)》本文介绍Java与LibreOffice的集成方法,涵盖环境配置、API调用、文档转换、UNO桥接及REST接口等技术,提供... 目录1. 引言2. 环境搭建2.1 安装 LibreOffice2.2 配置 Java 开发环境2.3 配

SpringBoot集成EasyExcel实现百万级别的数据导入导出实践指南

《SpringBoot集成EasyExcel实现百万级别的数据导入导出实践指南》本文将基于开源项目springboot-easyexcel-batch进行解析与扩展,手把手教大家如何在SpringBo... 目录项目结构概览核心依赖百万级导出实战场景核心代码效果百万级导入实战场景监听器和Service(核心

Spring Boot集成/输出/日志级别控制/持久化开发实践

《SpringBoot集成/输出/日志级别控制/持久化开发实践》SpringBoot默认集成Logback,支持灵活日志级别配置(INFO/DEBUG等),输出包含时间戳、级别、类名等信息,并可通过... 目录一、日志概述1.1、Spring Boot日志简介1.2、日志框架与默认配置1.3、日志的核心作用

Apache Ignite 与 Spring Boot 集成详细指南

《ApacheIgnite与SpringBoot集成详细指南》ApacheIgnite官方指南详解如何通过SpringBootStarter扩展实现自动配置,支持厚/轻客户端模式,简化Ign... 目录 一、背景:为什么需要这个集成? 二、两种集成方式(对应两种客户端模型) 三、方式一:自动配置 Thick