docs

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 3, 2025 License: MIT Imports: 1 Imported by: 0

Documentation

Overview

Package docs Code generated by swaggo/swag. DO NOT EDIT

Index

Constants

This section is empty.

Variables

View Source
var SwaggerInfo = &swag.Spec{
	Version:          "1.0.0",
	Host:             "api.darkkaiser.com:2443",
	BasePath:         "/",
	Schemes:          []string{},
	Title:            "Notify Server API",
	Description:      "웹 스크래핑을 통해 수집한 정보를 알림으로 전송하는 서버의 REST API입니다.\n\n이 API를 사용하면 외부 애플리케이션에서 텔레그램 등의 메신저로 알림 메시지를 전송할 수 있습니다.\n\n## 주요 기능\n- 알림 메시지 전송\n- 다양한 알림 채널 지원 (Telegram 등)\n- 애플리케이션별 인증 및 권한 관리\n\n## 인증 방법\nAPI 사용을 위해서는 사전에 등록된 애플리케이션 ID와 App Key가 필요합니다.\n설정 파일(notify-server.json)의 notify_api.applications에 애플리케이션을 등록한 후 사용하세요.\n\n## 인증 플로우\n1. **사전 준비**: notify-server.json의 notify_api.applications에 애플리케이션 등록\n- application_id, app_key, default_notifier_id 설정\n2. **API 호출**: Query Parameter로 app_key 전달\n- POST /api/v1/notice/message?app_key=YOUR_KEY\n3. **인증 검증**: 서버에서 application_id와 app_key 확인\n- 미등록 앱: 401 Unauthorized\n- 잘못된 app_key: 401 Unauthorized\n4. **알림 전송**: 인증 성공 시 텔레그램으로 메시지 전송\n- 성공: 200 OK\n\n자세한 인증 플로우 다이어그램은 GitHub README를 참조하세요.",
	InfoInstanceName: "swagger",
	SwaggerTemplate:  docTemplate,
	LeftDelim:        "{{",
	RightDelim:       "}}",
}

SwaggerInfo holds exported Swagger Info so clients can modify it

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL