pkg.gl

Categorygithub.com/04Akaps/gateway_module

modulepackage

0.0.0-20241026110119-92ec2b831816

Repository: https://github.com/04akaps/gateway_module.git

Documentation: pkg.go.dev

# README

377772070-d937bb49-c8c2-4e93-baa6-4e4b6b413d2e

✅ Gateway module ✅

📝 소개

Nginx, ApiSix와 같은 게이트웨이 역할을 할 수 있는 web-server입니다.

간단하게 정해진 yaml형태를 통해서 라우팅 처리를 하는 서버를 자동으로 배포 및 Request를 처리하게 됩니다.

🗂️ yaml 규격

다음과 같은 yaml 형태를 지원합니다.

기본적인 yaml의 경로는 ./deploy.yaml 파일 경로를 따르게 됩니다.
path에 대한 flag를 자유롭게 지원합니다.

1️⃣

app:
  name: "<Gatew Moudle Name>"
  version: v1
  port: "<Gatway Port>"

기본적인 module의 정보 입니다.

name : 원하는 module의 이름을 지정합니다.
version : version 관리를 합니다.
port : web-server의 port를 설정합니다.

2️⃣

http:
  base_url: "<Internal Service Base URL>"
  router:
    - method: "<Method>"
      get_type: "<Type>"
      path: "<Optional path>"
      header:
        Content-Type: "application/json"
        Accept: "application/json"
    - method: "<Method>"
      get_type: "<Type>"
      path: "<Optional path>"
      variable:
        - "address"
        - "tid"

라우팅하고자 하는 외부 서버의 정보를 입력하게 됩니다.

base_url : 외부 서버의 기본 url를 적어줍니다.
method : 외부 서버의 path가 지원하는 method 타입을 지정합니다.
- GET, POST, PUT, DELETE 를 지원합니다.
get_type : GET요청에 대해서 url, query 두가지를 지원합니다.
path : 추가적인 path를 입력해 줍니다.
header : 요청에 대해서 담고자 하는 정보를 추가합니다.
variable : GET 요청의 query 타입에 대해서 맵핑고자 하는 키 값을 입력합니다.

3️⃣

kafka:
  url: "<Kafka Producer Url>"
  client_id: "<Producer client id>"
  acks: "<producer acks>"
  topic: "<kafka topic>"
  batch_time: "<Request Produce Batch Time>"