msgbyte / msgbyte/tianji

API Endpoints return 404 despite ALLOW_OPENAPI=true (Docker Compose, Port Mapping, PowerShell Tests)

Open
#211 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
3.1k
Forks
194
Avg merge
18m
Merged PRs (30d)
3

Description

I deployed Tianji using Docker Compose and I'm currently on version v1.24.5 (previously tested with 1.24.4 as well). The environment variable ALLOW_OPENAPI is explicitly set in my compose file.

version: '3'
services:
tianji:
image: ghcr.io/msgbyte/tianji:latest
container_name: tianji
ports:
- "81:12345" # Zugriff per Port :81
environment:
DATABASE_URL: postgresql://tianji:tianji@postgres:5432/tianji
JWT_SECRET: simple-xxxxximple
DISABLE_ACCOUNT: "true"
ALLOW_OPENAPI: "true"
depends_on:
- postgres
restart: always
postgres:
image: postgres:15.4-alpine
container_name: tianji-postgres
environment:
POSTGRES_DB: tianji
POSTGRES_USER: tianji
POSTGRES_PASSWORD: tianji
volumes:
- tianji-db-data:/var/lib/postgresql/data
restart: always
healthcheck:
test: ["CMD-SHELL", "pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}"]
interval: 5s
timeout: 5s
retries: 5
volumes:
tianji-db-data:

I’m mapping port 81 externally to internal 12345 for Tianji.

✅ Observed API Behavior via PowerShell (Invoke-RestMethod):

Endpoint Status
GET /open/global/config ✅ Returns JSON as expected
GET /open/workspace/list ❌ 404 Not Found
GET /open/monitor/list ❌ 404 Not Found
POST /open/monitor/create ❌ 404 Not Found

✅ Additional Notes
The API documentation link https://tianji.dev/api leads to a blank page or redirects to the GitHub repository.
No Swagger/OpenAPI UI is available under /open or /open/swagger — both return 404.

❓ Questions
Is there a complete and up-to-date API documentation available?
Are there alternative endpoint paths for managing workspaces or monitors?
Or is the OpenAPI interface still under development or partially implemented in the current version?

Environment:
Tianji Version: v1.24.5
OS: Ubuntu 22.04
Deployment: Docker Compose
Port Mapping: 81 → 12345
API tests via: PowerShell Invoke-RestMethod

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the reported behavior with the Docker Compose configuration from the issue and PowerShell requests to /open/global/config, /open/workspace/list, /open/monitor/list, and /open/monitor/create. Then trace the API route and OpenAPI documentation entry points; done means the intended endpoint paths and documentation availability are clarified or the reported 404 behavior is corrected.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker-compose, postgresql, powershell, typescript
Domain
api, backend, databases, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.