Skip to content

Commit

Permalink
[LG-52] - add more details as docs for some modules
Browse files Browse the repository at this point in the history
  • Loading branch information
lglabs committed May 25, 2024
1 parent 37a0adf commit 0886cc1
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 9 deletions.
16 changes: 15 additions & 1 deletion docs/app/projects1/docs/api-module.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,16 @@
# API Module

> <h1> ⚠️ The Documentation in Progress... ⚠️</h1>
Implement input port from a primary adapter. For instance, Spring Rest Controller.

> <h1> ⚠️ The Documentation in Progress... ⚠️</h1>
### Dependencies
```xml title="pom.xml" linenums="1" hl_lines="4"
<dependencies>
<dependency>
<groupId>com.lg5.spring</groupId>
<artifactId>lg5-spring-api-rest</artifactId>
</dependency>
...
</dependencies>
```
11 changes: 10 additions & 1 deletion docs/app/projects1/docs/atdd-module.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,11 @@
# Acceptance Test(ATDD) Module

> <h1> ⚠️ The Documentation in Progress... ⚠️</h1>
> <h1> ⚠️ The Documentation in Progress... ⚠️</h1>
### Dependencies
```xml title="pom.xml" linenums="1" hl_lines="3"
<dependency>
<groupId>com.lg5.spring</groupId>
<artifactId>lg5-spring-atdd</artifactId>
</dependency>
```
8 changes: 4 additions & 4 deletions docs/app/projects1/docs/domain-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@

```xml title="pom.xml" linenums="1" hl_lines="3"
<dependency>
<groupId>com.lg5.jvm</groupId>
<artifactId>lg5-jvm-atdd</artifactId>
<groupId>com.lg5.spring</groupId>
<artifactId>lg5-spring-atdd</artifactId>
</dependency>
```

Expand Down Expand Up @@ -64,7 +64,7 @@

=== "message-core-module"

```xml title="pom.xml(core)" linenums="1" hl_lines="5 10"
```xml title="pom.xml" linenums="1" hl_lines="5 10"
<dependencies>
<!-- if you need to produce events-->
<dependency>
Expand All @@ -82,7 +82,7 @@

=== "message-model-module"

```xml title="pom.xml(model)" linenums="1" hl_lines="4"
```xml title="pom.xml" linenums="1" hl_lines="4"
<dependencies>
<dependency>
<groupId>com.lg5.spring.kafka</groupId>
Expand Down
19 changes: 16 additions & 3 deletions docs/app/projects1/docs/external-module.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# External Module

##
## Calling External System
> _Rest, Soap, gRpc, GraphQL, IA strategy, etc._

First, You must create or have an output port in the application service layer. So, You create an adapter for implement
these ports.
Expand All @@ -18,10 +20,21 @@ flowchart LR

Part I.

- Dto from Client Specific(e.g: Rest, Soap, gRpc, GraphQL, etc)
- DTO to client specific.
- Mappers

Part II.

- Implementing output ports(Publishers/Producers)
- Secondary Adapter
- Secondary Adapter

### Dependencies
```xml title="pom.xml" linenums="1" hl_lines="4"
<dependencies>
<dependency>
<groupId>com.lg5.spring</groupId>
<artifactId>lg5-spring-client</artifactId>
</dependency>
...
</dependencies>
```

0 comments on commit 0886cc1

Please sign in to comment.