Skip to content

Commit 6637463

Browse files
committed
update readme
1 parent 04e77d7 commit 6637463

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

Diff for: README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This project creates a blogging API service using [goserve](https://github.com/u
77

88
This project breaks down the monolithic go blog backend project provided at [goserve](https://github.com/unusualcodeorg/goserve) repository. It uses the [goserve](https://github.com/unusualcodeorg/goserve) REST API framework to build the auth_service, and blog_service.
99

10-
## Highlights
10+
### Highlights
1111
- goserve micro architecture
1212
- kong API gateway
1313
- nats for microservices communication
@@ -18,7 +18,7 @@ This project breaks down the monolithic go blog backend project provided at [gos
1818

1919
> More details on the REST part can be found at [goserve](https://github.com/unusualcodeorg/goserve) github repo
2020
21-
# Project Directories
21+
### Project Directories
2222
1. **kong**: kong configuration and plugins
2323
2. **auth_service**: auth APIs code
2424
3. **blog_service**: blog APIs code
@@ -28,7 +28,7 @@ This project breaks down the monolithic go blog backend project provided at [gos
2828
2. **.tools**: RSA key generator, and .env copier
2929
3. **.vscode**: editor config and service debug launch settings
3030

31-
# Microservice System Design
31+
## Microservice System Design
3232

3333
**Request Flow**
3434
- client request comes to kong
@@ -59,7 +59,7 @@ This project breaks down the monolithic go blog backend project provided at [gos
5959
**2. With Load Balancing**
6060
![Banner](.extra/docs/system-load-balanced.png)
6161

62-
# Installation Instructions
62+
## Installation Instructions
6363
vscode is the recommended editor - dark theme
6464

6565
**1. Get the repo**
@@ -96,17 +96,17 @@ You will be able to access the api from http://localhost:8000
9696

9797
> If having any issue make sure 8000 port is not occupied
9898
99-
## API DOC
99+
### API DOC
100100
[![API Documentation](https://img.shields.io/badge/API%20Documentation-View%20Here-blue?style=for-the-badge)](https://documenter.getpostman.com/view/1552895/2sA3dxCWsa)
101101

102-
# Read the Articles to understand this project
102+
## Read the Articles to understand this project
103103
[How to Architect Good Go Backend REST API Services](https://medium.com/@janishar.ali/how-to-architecture-good-go-backend-rest-api-services-14cc4730c05b)
104104

105-
# Documentation
105+
## Documentation
106106
Information about the framework
107107
> API framework details can be found at [goserve](https://github.com/unusualcodeorg/goserve) github repo
108108
109-
## NATS
109+
### NATS
110110
To communicate among services through nats a message struct is required
111111

112112
```go
@@ -129,7 +129,7 @@ func NewSampleMessage(f1, f2 string) *SampleMessage {
129129
}
130130
```
131131

132-
## Controller
132+
### Controller
133133
- It implements `micro.Controller` from `github.com/unusualcodeorg/goserve/arch/micro`
134134
- `MountNats` is used to mount the endpoints that other services can call through nats
135135
- `MountRoutes` is used to mount the endpoints for http clients
@@ -192,7 +192,7 @@ func (c *controller) getServicePingHandler(ctx *gin.Context) {
192192

193193
```
194194

195-
## Service
195+
### Service
196196
- `micro.RequestBuilder[message.SampleMessage]` is used to call other services to get `SampleMessage` through nats
197197

198198
```go
@@ -248,7 +248,7 @@ func (s *service) FindSample(id primitive.ObjectID) (*model.Sample, error) {
248248

249249
```
250250

251-
## NatsClient
251+
### NatsClient
252252
NatsClient should be created to connect and talk to nats
253253
```go
254254
natsConfig := micro.Config{

0 commit comments

Comments
 (0)