GET /api/v1/projects/{projectId}

GET/api/v1/projects/{projectId}

项目详情（需 viewer 及以上）

projectoperationId: projectGet

请求参数

名称	类型	位置	必填	说明
`projectId`	string	path	是	项目 ID（UUID）。携带 `X-API-Key` 时按 API Key scope 鉴权，否则按 JWT + 项目成员角色鉴权

请求示例

cURL

curl -X GET 'http://localhost:8080/api/v1/projects/{projectId}' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: <PROJECT_API_KEY>'
# 也可使用登录会话：-H 'Authorization: Bearer <JWT>'

JavaScript

const res = await fetch('http://localhost:8080/api/v1/projects/{projectId}', {
  method: 'GET',
  headers: {
    'Accept': 'application/json',
    'X-API-Key': '<PROJECT_API_KEY>'
  },
});
const data = await res.json();

Python

import requests

res = requests.get(
    'http://localhost:8080/api/v1/projects/{projectId}',
    headers={'Accept': 'application/json', 'X-API-Key': '<PROJECT_API_KEY>'}
)
print(res.json())

响应

200成功

application/json

{
  "type": "object",
  "properties": {
    "project": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "name": {
          "type": "string"
        },
        "slug": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "created_by": {
          "type": "string",
          "format": "uuid"
        },
        "status": {
          "type": "string"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time"
        }
      }
    },
    "role": {
      "type": "string",
      "enum": [
        "owner",
        "admin",
        "developer",
        "viewer"
      ]
    }
  }
}

401未认证或凭据无效

application/json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "not_found"
    },
    "message": {
      "type": "string",
      "example": "资源不存在"
    }
  }
}

403无权限（未通过 RBAC 或 2FA）

application/json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "example": "not_found"
    },
    "message": {
      "type": "string",
      "example": "资源不存在"
    }
  }
}

404项目不存在

在线调试

凭证仅保存在当前页面内存中

请求地址projectIdBearer Token

X-API-Key

自定义请求 Header