server

Overview ¶

Package main provides the Locky API server.

Locky API Server ¶

Locky is a JWT-based authentication and user management system with the following features:

• User authentication and authorization using JWT tokens
• User, Group, and Member management
• OpenStack Keystone-style API design
• REST API with multiple access levels (public, internal, private)

API Structure ¶

The API follows OpenStack Keystone design patterns:

• /v1/share/common/auth/* - Authentication endpoints (token management)
• /v1/public/* - Public API (no authentication required)
• /v1/internal/* - Internal API (authentication required)
• /v1/private/* - Private API (admin operations)

Authentication ¶

The system uses JWT tokens with the following endpoints:

• POST /v1/share/common/auth/tokens - Issue token (login)
• DELETE /v1/share/common/auth/tokens - Revoke token (logout)
• GET /v1/share/common/auth/tokens/validate - Validate token
• POST /v1/share/common/auth/tokens/refresh - Refresh token
• GET /v1/share/common/auth/tokens/user - Get user info from token

Configuration ¶

The server reads configuration from etc/app.yaml which includes:

• Database connection settings (MySQL/TiDB)
• Redis connection settings
• JWT secret key
• Admin user email list

Usage ¶

go run cmd/server/main.go

The server will start on http://localhost:8080 by default.

Schemes: http, https Host: localhost:8080 BasePath: /v1 Version: 1.0.0

Consumes: - application/json

Produces: - application/json

Security: - bearerAuth: []

SecurityDefinitions: bearerAuth:

type: apiKey
name: Authorization
in: header
description: "JWT token. Format: 'Bearer {token}'"

swagger:meta