Giter VIP home page Giter VIP logo

rest-demo's Introduction

Spring-Boot CXF JAXRS QuickStart

This example demonstrates how you can use Apache CXF with Spring Boot.

The quickstart uses Spring Boot to configure a little application that includes a CXF JAXRS endpoint with Swagger enabled.

Building

The example can be built with

mvn clean install

Running the example in OpenShift

It is assumed that:

Then the following command will package your app and run it on OpenShift:

mvn fabric8:deploy

To list all the running pods:

oc get pods

Then find the name of the pod that runs this quickstart, and output the logs from the running pods with:

oc logs <name of pod>

You can also use the OpenShift web console to manage the running pods, and view logs and much more.

Running via an S2I Application Template

Application templates allow you deploy applications to OpenShift by filling out a form in the OpenShift console that allows you to adjust deployment parameters. This template uses an S2I source build so that it handle building and deploying the application for you.

First, import the Fuse image streams:

oc create -f https://raw.githubusercontent.com/jboss-fuse/application-templates/GA/fis-image-streams.json

Then create the quickstart template:

oc create -f https://raw.githubusercontent.com/jboss-fuse/application-templates/GA/quickstarts/spring-boot-cxf-jaxrs-template.json

Now when you use "Add to Project" button in the OpenShift console, you should see a template for this quickstart.

Accessing the Endpoints

To access the endpoint you first need to create an OpenShift route for the service so that it can be exposed externally. You can use the 'oc create route' command to create the route and the 'oc get routes' to get the host name for the route that you created. Example:

$ oc create route edge example1 --service=spring-boot-cxf-jaxrs
route "example1" created

$ oc get routes example1
NAME       HOST/PORT                                PATH      SERVICES                PORT      TERMINATION
example1   example1-myproject.example.com                     spring-boot-cxf-jaxrs   http      edge

You can then use the host report to access the service.

https://example1-myproject.example.com/services/helloservice/sayHello/FIS will display "Hello FIS, Welcome to CXF RS Spring Boot World!!!"

http://example1-myproject.example.com/services/helloservice/swagger.json will return a Swagger JSON description of services.

Integration Testing

The example includes a fabric8 arquillian OpenShift Integration Test. Once the container image has been built and deployed in OpenShift, the integration test can be run with:

mvn test -Dtest=*KT

The test is disabled by default and has to be enabled using -Dtest. Open Source Community documentation at Integration Testing and Fabric8 Arquillian Extension provide more information on writing full fledged black box integration tests for OpenShift.

rest-demo's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.