ORDS Adapter Boilerplate

🚀Overview

ORDS Adapter Boilerplate is the ORDS library to covert request and response data between ORDS and Spring Boot ORDS Boilerplate

📚Table of Content

• Technical Stack
• Build and Run
• Folder Structure
• Generate Java Doc
• Trouble Shooting
• Reference

🔨Technical Stack

• Spring framework
• Java 8
• Maven 3

🏗Build and Run

STEP 1. Install dependancy

mvn install

STEP 2. Test

mvn clean test

STEP 3. Pack jar file

mvn clean package

STEP 4. Copy jar
Copy jar file from target/ords-adapter-boilerplate-1.0.0.jar to spring-boot-ords-boilerplate project

📦Folder Structure

• converter: convert request, response to entity
• entity: Object entity for origin ORDS data structure
• exception: Define exception
• parameter: Define RESTful API Parameters, Request, Response
• webclient: Connect ORDS with WebClient

📑Generate Java Doc

STEP 1. Run the command to generate Java doc

mvn javadoc:javadoc

STEP 2. Open Java doc
Open target/site/apidocs/index.html, it will show Java doc as well

🎯Trouble Shooting

Using > Java 8 to package jar file will trigger debug warning, see the link for detail: https://www.cnblogs.com/hapday/p/13140231.html

🗒Reference

• Logging requests using a filter function: https://www.callicoder.com/spring-5-reactive-webclient-webtestclient-examples/