Skip to content
Simple service status API provider/manager server
JavaScript CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
tests
.babelrc
.eslintrc
.gitignore
.scrutinizer.yml
.travis.yml
LICENSE
Procfile
README.md
app.json
gulpfile.js
package-lock.json
package.json
webpack.config.js

README.md

Simple Service Status

Greenkeeper badge Build Status npm Scrutinizer Code Quality

Overview

특정 앱/플랫폼 버전을 지정하여 공지사항을 전달할 수 있는 간단한 도구입니다. 공지사항을 관리할 수 있는 웹 UI와 질의를 위한 API를 제공합니다.

버전 비교를 위해서 내부적으로 SemVer를 사용하고 있습니다. 자세한 비교 방식을 확인하시려면 SemVer Calculator를 참조하세요.

Prerequisite

Install

$ git clone git@github.com:ridi/simple-service-status.git [target directory]
$ cd [taget directory]
$ npm install

Configure

필요한 경우 아래의 src/config/*.config.js를 수정하세요.

Configure Server server.config.js

  • defaults.host: 서버 구동 호스트
  • defaults.port: 서버 구동 포트
  • defaults.mongoDBUrl: MongoDB 접속 주소 (없을 경우 mongodb://localhost 사용)
  • auth.secretKey: 패스워드와 인증 토큰 암호화를 위한 비밀키 (없을 경우 "secretKey" 문자열 사용)
  • auth.tokenTTL: 발급된 token의 만료 시간
  • initialData: 서버 초기화 시 DB에 생성될 데이터

Configure Client client.config.js

  • editor.supportEnhancedFormat: 이 값을 true로 설정할 경우 UI Editor들의 모든 포매팅 기능을 사용할 수 있습니다.

Make .env file

server.config.js를 직접 수정하는 대신 환경변수를 사용해 설정 값을 덮어쓸 수 있습니다. 필요한 경우 프로젝트 루트에 .env 파일을 생성하고 다음의 값들을 설정합니다.

  • PORT: server.config.jsdefaults.port 참고
  • MONGODB_URI: server.config.jsdefaults.mongoDBUrl 참고
  • SECRET_KEY: server.config.jsauth.secretKey 참고
MONGODB_URI=mongodb://your.domain:port/database_name
SECRET_KEY=secret_key
PORT=8080

Run

Run Script

For development

# 다음을 실행하면 서버(포트 번호: 8080)와 모듈 핫 리로딩을 위한 서버(포트 번호: 3000)가 함께 구동됩니다.
npm run start:dev

For production

npm start

구동 후 http://localhost:8080으로 접속하면 관리 UI로 연결됩니다.

Test

npm test

Public API

Check Service Status

현재 디바이스 플랫폼과 앱 버전에 대해 공지사항이 있는지 확인한다.

GET /v1/status/check?device_type=[device_type]&device_version=[device_version]&app_version=[app_version]

Parameters

이름 타입 설명
device_type enum (*, android, ios, paper, qt) 디바이스(플랫폼) 종류 (더 추가될 수 있음)
device_version string (* or SemVer format) 디바이스 플랫폼 버전
app_version string (* or SemVer format) 뷰어 앱 버전 ('x.x.x' 형태 or '*' 입력)

Response (JSON)

배열 형태로 전달됩니다. 질의한 디바이스 타입과 버전에 맞는 알림이 없을 경우 빈 배열이 전달됩니다.

이름 타입 설명
id string 상태 ID
title string 알림 제목
type enum (serviceFailure, routineInspection) 상태 종류 (serviceFailure: 서버 문제, routineInspection: 정기 점검)
device_types array 알림의 대상 디바이스 종류
contents string 알림 내용 (HTML 형태)
is_activated boolean 알림 활성화 여부 (항상 true)
device_sem_version string 대상 디바이스 플랫폼 버전 비교 기준 (SemVer를 따름)
app_sem_version string 대상 뷰어 앱 버전 비교 기준 (SemVer를 따름)
start_time string (ISO 8601 포맷) 알림 시작 시간 (timezone 포함) - 설정되어 있지 않은 경우 모든 기간 대상
end_time string (ISO 8601 포맷) 알림 종료 시간 (timezone 포함) - 설정되어 있지 않은 경우 모든 기간 대상
create_time string (ISO 8601 포맷) 알림 생성 시간
update_time string (ISO 8601 포맷) 알림 수정 시간

Example

Request
GET /api/v1/status/check?device_type=android&device_version=3.5.6&app_version=3.5.6
Response (Success)
{
    "data": [
        {
            "id": "58783e50fdfef4e35318f620",
            "title": "...",
            "type": "routineInspection",
            "device_types": [
                "android"
            ],
            "contents": "<p>...</p>",
            "is_activated": true,
            "device_sem_version": ">=1.0.0  || =7.0.0-alpha.1",
            "app_sem_version": "<3.0.0 || =6.0.0",
            "start_time": "2017-01-13T11:40:55+09:00",
            "end_time": "2017-01-13T13:40:55+09:00",
            "create_time": "2017-04-19T16:53:30+09:00",
            "update_time": "2017-04-19T16:53:30+09:00"
        }
    ],
    "success": true
}
You can’t perform that action at this time.