1. 从web.xml 说起

    <servlet>

        <servlet-name>CXFServlet</servlet-name>

        <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>

        <load-on-startup>1</load-on-startup>

    </servlet>

    <servlet-mapping>

        <servlet-name>CXFServlet</servlet-name>

        <url-pattern>/*</url-pattern>

    </servlet-mapping>

如果这样配置，所有的请求都走CXF(意思是作为一种资源进行请求) ，就无法访问 swagger UI ，所以不能配置成/*

应该如下配置：

<?xml version="1.0" encoding="utf-8"?>

<web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"

    version="2.4">

    <display-name>JAX-RS Simple Service</display-name>

    <description>JAX-RS Simple Service</description>

    <context-param>

        <param-name>contextConfigLocation</param-name>

        <param-value>WEB-INF/beans.xml</param-value>

    </context-param>

    <listener>

        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>

    </listener>

    <listener>

        <listener-class>org.springframework.web.context.request.RequestContextListener</listener-class>

    </listener>

    <servlet>

        <servlet-name>CXFServlet</servlet-name>

        <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>

        <load-on-startup>1</load-on-startup>

    </servlet>

    <servlet-mapping>

        <servlet-name>CXFServlet</servlet-name>

        <url-pattern>/api/*</url-pattern>

    </servlet-mapping>

</web-app>

这样做{协议}{host}{port}{项目}{资源}

补充welcome files：http://docs.oracle.com/javaee/5/tutorial/doc/bnaeo.html#bnaer

The welcome files mechanism allows you to specify a list of files that the web container will use for appending to a request for a URL (called a valid partial request) that is not mapped to a web component.

例如：访问 http://localhost:8080/cxf-rs/

则会自动访问webapp 下的 index.XXX

2. swagger UI

You can use the swagger-ui code AS-IS! （原样）

把`dist` folder 下的文件copy 到 webapp下

或者（如果觉得乱）copy到webapp下的指定文件夹下例如：webapp/swagger

maven 的 webapp 最终生成war包后，不存在webapp ，项目目录即是webapp

一般来看如下：

出于安全考虑，非静态资源应该放在WEB-INF 里面。

如果想要实现以上效果，需要:

①配置welcome file 并将`dist` 中 index.html 的资源相对路径(src or href)修改为 swagger/..........

②配置welcome list

    <welcome-file-list>

        <welcome-file>swagger/index.html</welcome-file>

    </welcome-file-list>

然后访问 http://localhost:8080/cxf-rs/

又出现了 swagger ui 页面

如果想要修改为 index.jsp 需要执行以下操作：

①新建一个jsp文件

<%@ page language="java" contentType="text/html; charset=utf-8"

    pageEncoding="utf-8"%>

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<html>

<head>

<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

<title>Swagger UI JSP</title>

②将welcome list 修改为 swagger/index.jsp

3. web service 与 web project

被CXF 拦截的 url 是作为RESTful 资源访问，一般返回JSON

非CXF拦截的url是访问webapp 资源，页面跳转

这两种访问必须分清楚。

4.swagger 配置

https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-RESTEasy-2.X-Project-Setup-1.5

spring 方式

    <bean id="swaggerConfig" class="io.swagger.jaxrs.config.BeanConfig">

        <property name="resourcePackage" value="cn.zno.resource" />

        <property name="version" value="1.0.0" />

        <property name="host" value="localhost:8080/cxf-rs" />

        <property name="basePath" value="/api" />

        <property name="title" value="Swagger Petstore" />

        <property name="description" value="This is a app." />

        <property name="contact" value="apiteam@swagger.io" />

        <property name="license" value="Apache 2.0" />

        <property name="licenseUrl" value="http://www.apache.org/licenses/LICENSE-2.0.html" />

        <property name="scan" value="true" />

    </bean>

重要属性：

resourcePackage ：JAX-RS 的资源包

host：访问文档地址

basePath ：所有的资源url pattern 再追加，例如：某个java类中的资源@Path("/user") ，则这个资源最终是 api/user

其他属性：

title：这组api标题

contact：联系方式

前置：

    <!-- /* -->

    <!-- * resource -->

    <!-- * / -->

    <bean id="swaggerResource" class="io.swagger.jaxrs.listing.ApiListingResource" />

    <!-- /* -->

    <!-- * provider -->

    <!-- * / -->

    <bean id="swaggerWriter" class="io.swagger.jaxrs.listing.SwaggerSerializers" />

第一个是接收url请求（ swagger.json / swagger.yaml ）

第二个是将 swagger object 打印输出，交由swagger ui 展示

cxf-rs 和 swagger 的点的更多相关文章

WebService 之CXF(rs)之HelloWorld
1.建立mavenjava项目 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http ...
ajax跨域访问 java controller 和 cxf(webservice) 配置方式（CORS）
1. controller跨域访问,配置方式重点在这里: <mvc:cors> <mvc:mapping path="/*" allowed-origins=& ...
WebService--使用 CXF 开发 REST 服务
现在您已经学会了如何使用 CXF 开发基于 SOAP 的 Web 服务,也领略了 Spring + CXF 这个强大的组合,如果您错过了这精彩的一幕,请回头看看这篇吧: Web Service 那点事 ...
CXF 开发 REST 服务
今天我们将视角集中在 REST 上,它是继 SOAP 以后,另一种广泛使用的 Web 服务.与 SOAP 不同,REST 并没有 WSDL 的概念,也没有叫做"信封"的东西,因为 ...
webService之helloword(java)rs
webservice之rs(helloworld) 1.pom.xml文件 <dependencies>  <dependency& ...
SSH集成cxf 发布restful webservice
首先讲一下什么是restful webservice ,这个问题网上一搜有很多博文去长篇大论的介绍它,但是最后你看完了也会觉得云里雾里的,所以我在这里简单的讲一下我理解的rest webservice ...
webservice之jax-rs实现方式
1.什么叫restful风格 restful是一组架构约束条件和原则,满足这些约束条件和原则的应用程序即是restful风格. 2.jax-rs实现步骤 1.创建一个简单应用(略) 2.添加依赖jar ...
distributed OSGI demo
今天继续<OSGi原理与最佳实践>.看到第四章.做 HelloWorld-cxf 的样例照着样例敲来着,整个样例敲完了,执行.一直报错, ----------------这里是解决方法- ...
WebService基础入门 CXF(WS + RS)
一.基本介绍 Web Services是一个软件接口,它描述了一组可以在网络上通过标准化的 XML 消息传递访问的操作.它使用基于 XML 语言的协议来描述要执行的操作或者要与另一个 Web 服务交换 ...
Spring 、 CXF 整合 swagger 【试炼】
官网:http://swagger.io/ http://swagger.io/specification/ 上面就是描述了什么是 SWAGGER OBJECT 2. 如何用jax-rs 注解方式产生 ...

随机推荐

在linux中运行main方法所在的java类(亲测有效！！！)
本人是用SecureCRTPortable连接linux终端的.其他工具连接linux终端应该是一样的操作! 一.首先到移动到java工程所在的bin目录. 二.在bin目录下执行javac -cp ...
eclipse上一次没有正确关闭，导致启动的时候卡死错误解决方法
关于 eclipse启动卡死的问题(eclipse上一次没有正确关闭,导致启动的时候卡死错误解决方法),自己常用的解决方法: 方案一(推荐使用,如果没有这个文件,就使用方案二): 到<works ...
mongodb基础学习2-基本CRUD
接着学习一下mongodb的基本的CRUD 先列出基本知识点,再给出相关的例子增:语法: db.collectionName.insert(document); 1: 增加单篇文档,不指定_id时会 ...
读取数据库信息并生成表设计文档Word版本
1.参考C#代码 using Help.DBAccessLayer.Business; using Help.DBAccessLayer.Model.SqlGenerator; using Newto ...
hadoop发行版本
Azure HDInsight Azure HDInsight is Microsoft's distribution of Hadoop. The Azure HDInsight ecosystem ...
gorm中数据库datetime类型的映射和time.Time的格式化
如果在结构体中设置time变量的类型是time.Time,那么gorm取出来的时间格式将会是”2006-01-02 15:04:05.999999999 -0700 MST“东八区时间,在time.T ...
Memtester——Linux内存测试工具
一.Memtester简单介绍 Memtester主要是捕获内存错误和一直处于很高或者很低的坏位, 其测试的主要项目有随机值,异或比较,减法,乘法,除法,与或运算等等. 通过给定测试内存的大小和次数, ...
Ecshop模板目录介绍[xyytit]
一. 模板系统介绍 Ecshop模板系统使用我们自行研发的模板控制系统和著名的PHP开源模板程序Smarty组合而成.为了方便用户开发模板,还使用了Dreamweaver的模板和库的功能Smarty中 ...
OpenStack的架构详解（转）
OpenStack既是一个社区,也是一个项目和一个开源软件,它提供了一个部署云的操作平台或工具集.其宗旨在于,帮助组织运行为虚拟计算或存储服务的云,为公有云.私有云,也为大云.小云提供可扩展的.灵活的 ...
解决 listView gridView 与ScrollView嵌套时的冲突
package com.xqx.fight; import android.app.Activity; import android.os.Bundle; import android.view.Me ...