X–1 docs / 05 主站

API接口文档

05-A00-API接口文档.md · 1430 字

API接口文档

项目代号: A00
项目名称: TJFS集团官方网站及Web服务器
文档类型: API接口文档
创建日期: 2026-03-05
编制人: TBs
文档版本: V1.0
文档状态: 已批准

目录

  1. 接口概述
  2. 公共说明
  3. 静态文件接口
  4. 错误码说明
  5. 附录

一、接口概述

1.1 基本信息

项目内容
接口基础路径/
接口协议HTTP
数据格式HTML/CSS/JS/JSON
字符编码UTF-8
服务器端口80（默认）/ 8537（备用）

1.2 接口列表

接口编号接口名称请求方法接口路径说明
API-001首页GET/TJFS集团官网首页
API-002SG StudioGET/sgstudio/松果工作室子站点
API-003TBs科技GET/tbs/创生软件子站点
API-004CSS样式GET/css/style.css主样式文件
API-005JavaScriptGET/js/main.js主脚本文件

二、公共说明

2.1 请求头

请求头类型必填说明
Acceptstring否text/html, application/json
Accept-Encodingstring否gzip, deflate
Accept-Languagestring否zh-CN, zh, en
User-Agentstring否浏览器标识

2.2 响应头

响应头说明
Content-Type根据文件类型自动设置
Content-Length文件大小
Access-Control-Allow-Origin*（允许跨域）
Access-Control-Allow-MethodsGET, POST, OPTIONS
Access-Control-Allow-HeadersContent-Type

2.3 响应格式

HTML响应

HTTP/1.0 200 OK
Content-Type: text/html; charset=utf-8
Content-Length: 12345
Access-Control-Allow-Origin: *

<!DOCTYPE html>
<html lang="zh-CN">
...
</html>

CSS响应

HTTP/1.0 200 OK
Content-Type: text/css
Content-Length: 5678
Access-Control-Allow-Origin: *

/* CSS内容 */

JavaScript响应

HTTP/1.0 200 OK
Content-Type: application/javascript
Content-Length: 9012
Access-Control-Allow-Origin: *

// JavaScript内容

三、静态文件接口

3.1 首页

基本信息

项目内容
接口路径/
请求方法GET
认证要求否
接口描述TJFS集团官网首页

请求参数

无

响应参数

参数名类型说明
-HTML首页HTML内容

响应示例

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <title>T.J.F.S.集团 | 天工未来</title>
    ...
</head>
<body>
    ...
</body>
</html>

3.2 SG Studio子站点

基本信息

项目内容
接口路径/sgstudio/
请求方法GET
认证要求否
接口描述松果工作室子站点首页

请求参数

无

响应参数

参数名类型说明
-HTMLSG Studio首页HTML内容

3.3 TBs科技子站点

基本信息

项目内容
接口路径/tbs/
请求方法GET
认证要求否
接口描述创生软件子站点首页

请求参数

无

响应参数

参数名类型说明
-HTMLTBs科技首页HTML内容

3.4 CSS样式文件

基本信息

项目内容
接口路径/css/style.css
请求方法GET
认证要求否
接口描述主样式文件

请求参数

无

响应参数

参数名类型说明
-CSS样式规则

3.5 JavaScript文件

基本信息

项目内容
接口路径/js/main.js
请求方法GET
认证要求否
接口描述主脚本文件

请求参数

无

响应参数

参数名类型说明
-JavaScript脚本代码

四、错误码说明

4.1 HTTP状态码

状态码说明
200成功
304未修改（缓存）
400请求参数错误
404资源不存在
500服务器内部错误

4.2 错误响应示例

404 Not Found

HTTP/1.0 404 Not Found
Content-Type: text/html; charset=utf-8

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
        "http://www.w3.org/TR/html4/strict.dtd">
<html>
    <head>
        <title>Error response</title>
    </head>
    <body>
        <h1>Error response</h1>
        <p>Error code: 404</p>
        <p>Message: File not found.</p>
    </body>
</html>

500 Internal Server Error

HTTP/1.0 500 Internal Server Error
Content-Type: text/html; charset=utf-8

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
        "http://www.w3.org/TR/html4/strict.dtd">
<html>
    <head>
        <title>Error response</title>
    </head>
    <body>
        <h1>Error response</h1>
        <p>Error code: 500</p>
        <p>Message: Internal Server Error.</p>
    </body>
</html>

五、附录

附录A: 接口调用示例

cURL示例

# 访问首页
curl -X GET "http://localhost/"

# 访问CSS文件
curl -X GET "http://localhost/css/style.css"

# 访问JS文件
curl -X GET "http://localhost/js/main.js"

JavaScript示例

// 获取首页内容
fetch('http://localhost/')
  .then(response => response.text())
  .then(html => console.log(html));

// 获取CSS文件
fetch('http://localhost/css/style.css')
  .then(response => response.text())
  .then(css => console.log(css));

Python示例

import requests

# 访问首页
response = requests.get('http://localhost/')
print(response.status_code)
print(response.text)

# 访问CSS文件
response = requests.get('http://localhost/css/style.css')
print(response.status_code)
print(response.text)

附录B: 文件目录结构

web.sever/
├── index.html          # 首页
├── css/
│   └── style.css       # 主样式
├── js/
│   └── main.js         # 主脚本
├── sgstudio/
│   └── index.html      # SG Studio子站点
├── tbs/
│   └── index.html      # TBs科技子站点
└── start-server.py     # 服务器启动脚本

附录C: 变更记录

版本日期变更内容变更人
V1.02026-03-05初始版本TBs

文档编制日期: 2026-03-05
编制单位: SG Studio - 松果工作室
文档版本: V1.0