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 注解方式产生 ...

随机推荐

Django之 Model Field Options
以下这些选项都是可选择的,非固定要求. 1)null,注意在CharField或者TextField里避免使用null,因为其存储的值是空字符串而不是NULL 2)blank该字段是否可以为空.如果为 ...
python之类的相关知识
面向对象技术简介类: 用来描述具有相同的属性和方法的对象的集合.它定义了该集合中每个对象所共有的属性和方法.对象是类的实例. 类变量:类变量在整个实例化的对象中是公用的.类变量定义在类中且在函数体之 ...
python远程调试及celery调试
部分来自 from: https://www.xncoding.com/2016/05/26/python/pycharm-remote.html 你是否经常要在Windows 7或MAC OS X上 ...
Haskell语言学习笔记（69）Yesod
Yesod Yesod 是一个使用 Haskell 语言的 Web 框架. 安装 Yesod 首先更新 Haskell Platform 到最新版 (Yesod 依赖的库非常多,版本不一致的话很容易安 ...
OpenCv 人脸识别基础
#include <opencv2\opencv.hpp> #include <iostream> using namespace std; int main() { // 摄 ...
mysql在linux中安装问题和命令
1. cd / 切换到根目录. 2. cd /root 切换到根目录下的 root目录. 3. cd .. 切换到当前目录的上级目录. 4. rpm --qa mysql 查询已经安装mysql. ...
利用R产生随机数
生成随机数有两个函数runif()和rnorm(),其中r表示的是random随机的意思,unif表示的是均匀分布,而norm表示的是正态分布. 1)生成10个2到3之间的,服从均匀分布的随机数:ru ...
EasyUI查询
<script type="text/javascript">  function search_xxx() { var search ...
如何快速实现一个command
新建一个类,实现icoomand接口定义一个委托,为测试方便,先不考虑CanExecute的情况. 越简单越好. 代码如下: public class ExitHandler : ICommand ...
tf.unstack\tf.unstack
tf.unstack 原型: unstack( value, num=None, axis=0, name='unstack' ) 官方解释:https://tensorflow.google.cn/ ...