第一个 API

开始

我的故事从最简单的地方开始:上线一个 API 服务。

那时候的我还不知道,这段旅程会教会我多少东西。

起因

我一直想做一个 API 平台,让开发者可以方便地获取各种数据。

没有什么复杂的理由,就是想试试自己能不能做起来。

我先把网页搭建起来:

https://www.kuaiyizhi.cn
K

快易查

生活服务

天气查询 API

获取全球城市的实时天气信息,包括温度、湿度、天气状况等

GET/api/weather
金融服务

汇率转换 API

支持 150+ 种货币的实时汇率查询和转换

GET/api/exchange
网络工具

IP 地址查询 API

根据 IP 地址获取地理位置、运营商等信息

GET/api/ip
人工智能

文本分析 API

情感分析、关键词提取、文本分类等 NLP 功能

POST/api/text/analyze
网络工具

二维码生成 API

自定义样式生成二维码,支持 Logo 和颜色配置

POST/api/qrcode
生活服务

节假日查询 API

查询中国法定节假日、调休安排、工作日信息

GET/api/holiday

今天,先上线第一个功能:天气查询 API。

需求

很简单:开发者调用我的 API,传入城市名称,返回天气信息。

GEThttps://kuaiyizhi.cn/api/weather?city=北京
200 OKapplication/json
{
  "city": "北京",
  "temperature": "25°C",
  "condition": "晴",
  "humidity": "60%"
}

我的想法

我没有气象数据,但发现有个天气 API 可以调用。

我的 API 接收请求,去外部天气 API 获取数据,再返回给用户:

程序流程设计

Weather API 工作流程

用户请求北京天气

调用外部 API

存调用记录到 MySQL

返回给用户

MySQL 数据表设计

我需要将用户的请求日志记录下来,方便将来分析:

api_logsFields
字段名类型约束 / 说明
idBIGINTPRIMARY KEY, AUTO_INCREMENT
endpointVARCHAR(255)NOT NULL
paramsTEXT请求参数
response_statusINTHTTP 状态码
response_timeINT响应时间(ms)
created_atTIMESTAMPDEFAULT CURRENT_TIMESTAMP
api_logsRows
idendpointparamsresponse_statusresponse_timecreated_at
1/api/weathercity=北京2001182026-03-31 14:00:00
2/api/weathercity=上海2001322026-03-31 14:01:00
3/api/weathercity=广州5002402026-03-31 14:02:00

买设备

我在阿里云买了一台服务器和一个域名,准备先运营一年试试。

订单编号: ALI-20240101-XXXX-XXXX
云服务器 ECS
实例规格:ecs.t6-c1m1.large
CPU / 内存:1 核 2 GB
系统盘:40 GB 高效云盘
带宽:1 Mbps
地域:华东 1(杭州)
购买时长:1 年¥459.00
域名注册
域名:kuaiyizhi.cn
后缀:.cn
DNS:阿里云 DNS
购买时长:1 年¥39.00
实付金额¥498.00

部署

初始化服务器环境,我安装了这些软件:

  • Nginx: 反向代理服务器,处理 HTTP 请求。
  • Python: 运行我的 API 服务。
  • MySQL: 存储用户数据和日志。

最终我成功部署了我的 API 服务。

上线

我把 API 发布到了开发者社区:

kuaiyizhi.cn/docs/weather

天气查询 API

  • 接口地址

    • GET https://kuaiyizhi.cn/api/weather?city=城市名
  • 示例请求

    • GET https://kuaiyizhi.cn/api/weather?city=北京
  • 返回示例

    {
      "city": "北京",
      "temperature": "25°C",
      "condition": "晴",
      "humidity": "60%"
    }

一切正常!🎉

资源占用

我去阿里云的监控平台看了看,发现我的 API 服务占用的资源非常少:

云服务器 ECS 运行正常cn-hangzhou
CPU 5%
内存0.24 GB / 2 GB 12%
磁盘3.2 GB / 40 GB 8%

毕竟刚开始嘛,访问量不大,性能压力也不大。

当前架构

技术架构
客户端

用户请求

GET https://kuaiyizhi.cn/api/weather?city=北京
应用服务

Nginx

Python

Public API


MySQL

外部服务

外部天气 API

发现内容有问题?

告诉我们哪里需要改进。