Official Joke API 项目教程

Official Joke API 项目教程

official_joke_api Official Joke API! 项目地址: https://gitcode.com/gh_mirrors/of/official_joke_api

1. 项目的目录结构及介绍

official_joke_api/
├── jokes/
│   └── jokes.json
├── .gcloudignore
├── .gitignore
├── .npmignore
├── CODEOWNERS
├── LICENSE
├── README.md
├── app.yaml
├── handler.js
├── index.js
├── package-lock.json
├── package.json
└── test.js

• jokes/: 包含笑话数据的目录，主要文件是 jokes.json，存储了所有笑话的数据。
• .gcloudignore: 用于忽略在 Google Cloud 部署时不需要的文件。
• .gitignore: 用于忽略在 Git 版本控制中不需要的文件。
• .npmignore: 用于忽略在 npm 发布时不需要的文件。
• CODEOWNERS: 定义了项目的代码所有者。
• LICENSE: 项目的开源许可证，本项目使用 MIT 许可证。
• README.md: 项目的介绍文档，包含项目的使用说明和相关信息。
• app.yaml: 项目的配置文件，用于定义 Google App Engine 的部署配置。
• handler.js: 处理 HTTP 请求的文件，定义了如何响应不同的 API 请求。
• index.js: 项目的入口文件，启动服务器并监听端口。
• package-lock.json: 锁定项目依赖的版本。
• package.json: 项目的配置文件，包含项目的依赖和脚本。
• test.js: 项目的测试文件，用于测试 API 的功能。

2. 项目的启动文件介绍

项目的启动文件是 index.js。该文件主要负责启动服务器并监听指定的端口。以下是 index.js 的主要内容：

const express = require('express');
const handler = require('./handler');

const app = express();
const port = process.env.PORT || 3005;

app.get('/jokes/random', handler.randomJoke);
app.get('/jokes/ten', handler.randomTen);
app.get('/jokes/:type/random', handler.randomJokeByType);
app.get('/jokes/:type/ten', handler.randomTenByType);
app.get('/jokes/:id', handler.jokeById);

app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

• express: 引入 Express 框架，用于创建和配置 HTTP 服务器。
• handler: 引入 handler.js 文件，该文件定义了如何处理不同的 API 请求。
• app.get(...): 定义了不同的 API 路由，每个路由对应一个处理函数。
• app.listen(...): 启动服务器并监听指定的端口（默认是 3005）。

3. 项目的配置文件介绍

项目的配置文件主要包括 app.yaml 和 package.json。

app.yaml

app.yaml 是 Google App Engine 的配置文件，定义了项目的部署配置。以下是 app.yaml 的内容：

runtime: nodejs14

handlers:
- url: /.*
  script: auto

• runtime: 指定运行时环境，这里是 Node.js 14。
• handlers: 定义了 URL 路由的处理方式，/.* 表示匹配所有 URL，script: auto 表示自动处理。

package.json

package.json 是 Node.js 项目的配置文件，包含项目的依赖和脚本。以下是 package.json 的主要内容：

{
  "name": "official-joke-api",
  "version": "1.0.0",
  "description": "Official Joke API",
  "main": "index.js",
  "scripts": {
    "start": "node index.js",
    "dev": "nodemon index.js"
  },
  "dependencies": {
    "express": "^4.17.1"
  },
  "devDependencies": {
    "nodemon": "^2.0.7"
  }
}

• name: 项目的名称。
• version: 项目的版本号。
• description: 项目的描述。
• main: 项目的入口文件，这里是 index.js。
• scripts: 定义了项目的脚本，start 用于启动项目，dev 用于开发环境下的启动。
• dependencies: 项目的生产依赖，这里是 Express 框架。
• devDependencies: 项目的开发依赖，这里是 nodemon，用于自动重启服务器。

official_joke_api Official Joke API! 项目地址: https://gitcode.com/gh_mirrors/of/official_joke_api