后端API设计【免费下载链接】SpaceX-API:rocket: Open Source REST API for SpaceX launch, rocket, core, capsule, starlink, launchpad, and landing pad data.项目地址https://gitcode.com/gh_mirrors/spa/SpaceX-API点击查看免费下载本篇技术指南围绕 SpaceX-API 开源仓库rSpaceX-API中v4/landpads资源下的核心端点GET /v4/landpads展开讲解如何一次性获取 SpaceX 全部着陆坪Landing Pad的完整数据。文中不仅给出可立即复制的请求方式与字段含义表还会深入仓库源码路由实现、Mongoose 模型、定时任务揭示该端点的数据模型、Redis 缓存与统计字段的维护机制读完即可将该接口用于发射信息展示、着陆统计等实战场景。接口概览端点、方法与认证GET /v4/landpads是 v4 版本 API 中用于获取全部着陆坪数据列表的端点。它的调用信息非常简洁项目值MethodGETURLhttps://api.spacexdata.com/v4/landpadsAuth requiredFalse公开只读接口无需携带spacex-key请求头Success Code200 OK该端点返回一个 JSON数组数组中的每个元素对应一个着陆坪的完整对象默认按数据库存储顺序返回全量数据。在仓库源码中该路由定义于 routes/landpads/v4/index.js其核心实现只有寥寥数行// Get all landpads router.get(/, cache(300), async (ctx) { try { const result await Landpad.find({}); ctx.status 200; ctx.body result; } catch (error) { ctx.throw(400, error.message); } });可以看到路由通过 Mongoose 模型的find({})查询全表成功后以200状态码直接返回文档数组若查询过程抛错则返回400 Bad Request及错误信息。同时该路由挂在cache(300)中间件之下表示响应会被 Redis 缓存 300 秒详见下文“缓存机制”小节。另外从路由前缀/(v4|latest)/landpads可以看出该资源同时支持/v4与/latest两种版本别名。响应示例一个真实的着陆坪对象请求成功后200 OK接口返回的数组元素如下所示节选自 docs/landpads/v4/all.md 中的官方示例[ { name: LZ-2, full_name: Landing Zone 2, status: active, type: RTLS, locality: Cape Canaveral, region: Florida, latitude: 28.485833, longitude: -80.544444, landing_attempts: 3, landing_successes: 3, wikipedia: https://en.wikipedia.org/wiki/Landing_Zones_1_and_2, details: SpaceXs first east coast landing pad is Landing Zone 1, where the historic first Falcon 9 landing occurred in December 2015. LC-13 was originally used as a launch pad for early Atlas missiles and rockets from Lockheed Martin. LC-1 was later expanded to include Landing Zone 2 for side booster RTLS Falcon Heavy missions, and it was first used in February 2018 for that purpose., launches: [ 5eb87d13ffd86e000604b360, 5eb87d2dffd86e000604b376, 5eb87d35ffd86e000604b37a ], id: 5e9e3032383ecb90a834e7c8 }, ... ]响应体是一个数组数组中每个对象代表一个着陆坪如示例中的 LZ-2 / Landing Zone 2末尾的...表示还有其他着陆坪对象。该接口无鉴权要求可被浏览器地址栏直接访问是最简单的快速体验方式。响应字段完整解析为准确理解每个字段的含义、类型与取值范围可对照同目录下的 Landing Pad Schema 文档。其底层定义可在 models/landpads.js 中看到两者完全一致唯一差异是模型中还额外包含images.large字段见下文。逐字段说明如下字段类型说明nameString着陆坪短名称如LZ-2默认nullfull_nameString着陆坪全称如Landing Zone 2默认nullstatusString着陆坪状态必填枚举值为active、inactive、unknown、retired、lost、under constructiontypeString着陆类型如示例中的RTLSReturn To Launch Site返回发射场回收默认nulllocalityString所在地点城市/地区名如Cape CanaveralregionString所在大区/州如FloridalatitudeNumber纬度WGS-84如28.485833longitudeNumber经度WGS-84如-80.544444landing_attemptsNumber该着陆坪累计着陆尝试次数默认0landing_successesNumber该着陆坪累计成功着陆次数默认0wikipediaString维基百科词条链接可进一步了解历史detailsString着陆坪详细历史描述launchesArrayUUID关联的发射 ID 列表每个 ID 对应launches资源中的一次发射idString着陆坪唯一标识MongoDB ObjectId 字符串形式源码中的补充字段images在 models/landpads.js 中模型还定义了一个文档中未出现的字段images.large字符串数组用于存放着陆坪大图 URL。这说明在线文档描述的字段是数据主集而实际模型允许的字段范围更宽若在后续查询中使用select明确指定该字段仍可能取到图片数据。字段约束的源码级验证status枚举校验模型通过 Mongoose 的enum约束限定取值写入非法值如closed会被拒绝。该约束同样作用于管理端创建/更新接口见下文。launches引用关系模型中以mongoose.ObjectId数组存储并ref: Launch指向发射集合因此可以通过/query接口的populate选项把 UUID 直接替换为完整的发射对象详见 查询与分页指南。文本索引模型在name、full_name、details三个字段上建立了 text 索引models/landpads.js意味着/query接口支持 MongoDB 的$text全文检索如$search: cape对所有已索引的字符串字段进行搜索。源码级实现从请求到响应的完整链路结合仓库代码一次GET /v4/landpads请求的处理链路为路由匹配请求进入 routes/landpads/v4/index.js 的 Koa Router前缀/(v4|latest)/landpads命中/路径缓存判断cache(300)中间件先检查 Redis 中是否已有相同请求的缓存键由方法、URL、请求体经 BLAKE3 哈希生成命中则直接返回200与缓存体并打上spacex-api-cache: HIT响应头未命中则继续向下执行middleware/cache.js数据查询Landpad.find({})从 MongoDB 中取出全部着陆坪文档响应回写ctx.body result序列化为 JSON 数组返回状态码200Redis 在响应后写入缓存并设置 300 秒过期同时通过Cache-Control: max-age300响应头告知客户端可复用缓存仅在生产环境NODE_ENVproduction时启用 Redis 缓存见 middleware/cache.js。模型层的完整定义见 models/landpads.js它额外挂载了mongoosePaginate分页支持与mongoose-id返回id字段两个插件这也是GET /v4/landpads返回的每个对象都带id而非_id的原因。缓存机制与响应头cache(300)意味着接口响应默认被缓存300 秒5 分钟。从 middleware/cache.js 可以看出成功响应会附带以下响应头spacex-api-cache取值为HIT命中缓存或MISS未命中本次回源spacex-api-cache-online表示 Redis 缓存服务是否在线Cache-Control: max-age300指示下游客户端/代理可缓存 5 分钟。因此在实际调用中即使高频轮询该端点也可以获得稳定的响应速度同时应注意数据最长可能有 5 分钟的延迟——需要实时数据的场景建议使用下文/query接口并配合pagination: false。着陆坪资源族的其他端点GET /v4/landpads只是该资源族的一个端点仓库同目录下还提供了另外三种能力便于精确获取数据获取单个着陆坪MethodGETURLhttps://api.spacexdata.com/v4/landpads/:idURL 参数id[string]着陆坪的 ID如5e9e3032383ecb90a834e7c8Success200 OK返回单个着陆坪对象结构与数组元素一致Error404 NOT FOUNDID 不存在时返回Not Found详见 one.md该路由在源码中的实现为Landpad.findById(ctx.params.id)查不到时ctx.throw(404)routes/landpads/v4/index.js。自定义查询与分页MethodPOSTURLhttps://api.spacexdata.com/v4/landpads/queryBody{ query: {}, options: {} }其中query接受任意合法的 MongoDBfind()查询options支持select、sort、offset、page、limit、pagination、populate等分页与投影选项docs/landpads/v4/query.md例如只取东海岸Florida地区、状态为 active 的着陆坪{ query: { region: Florida, status: active }, options: { select: { name: 1, full_name: 1, latitude: 1, longitude: 1 }, sort: { name: asc }, limit: 10 } }完整的查询语法、分页参数与populate用法可参考 docs/queries.md若需将launches数组中的 UUID 展开为发射对象可在options.populate中指定[launches]。查询失败如字段名拼写错误时返回400 Bad Request响应体中会携带 Mongoose 错误信息与修正建议。数据从哪来统计字段的定时维护机制landing_attempts与landing_successes两个统计字段并非写死在文档里而是由仓库中的定时任务维护。在 jobs/worker.js 中landpads任务以 Cron 表达式*/10 * * * *配置即每 10 分钟运行一次。该任务的核心逻辑位于 jobs/landpads.js通过POST /v4/landpads/queryoptions.pagination: false拉取全部着陆坪对每个着陆坪分别向POST /v4/launches/query发起两次查询统计尝试次数查询cores数组中存在landpad等于当前着陆坪 ID 且landing_attempt: true的未发射记录数统计成功次数在上述条件基础上额外要求landing_success: true并同时限定upcoming: false、success: true用两次查询返回的totalDocs通过PATCH /v4/landpads/:id携带spacex-key认证头回写landing_attempts与landing_successes全部更新完成后输出日志Landpads updated若配置了LANDPADS_HEALTHCHECK环境变量还会上报健康检查探活。这解释了为什么GET /v4/landpads返回的统计数据会自动保持更新——上游任务每 10 分钟基于发射数据重新聚合一次着陆记录。实战演练快速调用与结果验证使用 curl 获取全部着陆坪curl -s https://api.spacexdata.com/v4/landpads | jq .使用 curl 获取单个着陆坪curl -s https://api.spacexdata.com/v4/landpads/5e9e3032383ecb90a834e7c8 | jq { name, full_name, status, landing_attempts, landing_successes }使用 Python 请求库获取并统计import requests resp requests.get(https://api.spacexdata.com/v4/landpads) landpads resp.json() print(f共返回 {len(landpads)} 个着陆坪) for pad in landpads: print(f{pad[name]} | {pad[status]} | 尝试 {pad[landing_attempts]} / 成功 {pad[landing_successes]})验证要点无鉴权时即可访问status_code应为200响应头中可观察Cache-Control: max-age300数组长度与/query返回的totalDocs一致在 query.md 的示例中为7个着陆坪可作为交叉校验。相关文档与进一步阅读Get all landing pads本文档Get one landing padQuery landing padsLanding Pad SchemaQuery Pagination Guide源码模型 models/landpads.js、路由 routes/landpads/v4/index.js、定时任务 jobs/landpads.js 与任务调度 jobs/worker.js赞分享后端API设计【免费下载链接】SpaceX-API:rocket: Open Source REST API for SpaceX launch, rocket, core, capsule, starlink, launchpad, and landing pad data.项目地址https://gitcode.com/gh_mirrors/spa/SpaceX-API点击查看免费下载相关推荐SpaceX-API 陆上着陆场查询接口详解/v4/landpads/query 的查询语法、分页与数据关联SpaceX API 陆上着陆场查询接口详解/v4/landpads/query 的查询语法、分页与数据关联 本篇文章围绕开源项目 SpaceX API 中后端API设计SpaceX-API v4 单个着陆场查询接口实战GET /v4/landpads/:id 返回结构、字段语义与源码实现解析SpaceX API v4 单个着陆场查询接口实战GET /v4/landpads/:id 返回结构、字段语义与源码实现解析 本文以 SpaceX API 开后端API设计SpaceX-API v4 Rockets 接口完整指南获取全部火箭数据GET /v4/rocketsSpaceX API v4 Rockets 接口完整指南获取全部火箭数据GET /v4/rockets 本文基于 SpaceX API https://l后端API设计创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考