You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ARCHITECTURE.md
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,5 @@
1
-
# XAP SDK Architecture
2
-
## Overview
3
-
The XAP (Expedia Affiliate Platform) SDK is structured as a multi-module Gradle project designed to generate a Kotlin/Java SDK from OpenAPI specifications. The architecture follows a code generation approach, where API client code is automatically generated and then published to repositories for consumption by developers.
1
+
# Overview
2
+
The XAP (Expedia API Platform) SDK is structured as a multi-module Gradle project designed to generate a Kotlin/Java SDK from OpenAPI specifications. The architecture follows a code generation approach, where API client code is automatically generated and then published to repositories for consumption by developers.
4
3
5
4
The repository contains the following key components:
6
5
-**OpenAPI Specifications**: Defines the API endpoints, request/response models, and data types.
@@ -12,7 +11,7 @@ The repository contains the following key components:
12
11
-**Documentation**: Contains guides and references for developers to understand and utilize the SDK effectively.
13
12
-**Testing**: Includes unit, integration and end-to-end tests to ensure the correctness and reliability of the generated SDK.
@@ -26,10 +25,10 @@ The repository contains the following key components:
26
25
-**Code Quality**: Ktlint
27
26
-**Code Coverage**: Kover
28
27
29
-
##Modules
28
+
# Modules
30
29
The project is organized into several modules, each serving a specific purpose. The main modules include:
31
30
32
-
###`generator` module
31
+
## `generator` module
33
32
This module is responsible for the core functionality of the SDK generation process. It consumes the OpenAPI specifications and generates the initial SDK code using OpenAPI Generator. It also integrates with the `expediagroup-sdk-openapi-plugin`. The module contains the following components:
34
33
-**OpenAPI Generator Configurations**: The core library that generates the SDK code from OpenAPI specifications. Lives in the `build.gradle.kts` file.
35
34
-**Custom Templates**: Custom templates for generating Kotlin/Java code. Lives in the `src/main/resources/templates` directory.
0 commit comments