Postman|创建 OpenAPI 规范文档
了解如何为后端项目创建规范文档。
OpenAPI 是一种用来写 API 说明书的标准格式,类似于给程序接口写的一份说明文档,通常使用 YAML 或 JSON 格式编写。Postman 支持从 OpenAPI 文档,自动生成接口文档、客户端/服务端代码、生成 Mock 接口。
因此,为后端项目维护一份 OpenAPI 文档,能提升开发效率。
openapi: 3.0.0
info:
title: Sample API
version: 1.0.0
paths:
/hello:
get:
summary: Say Hello
responses:
'200':
description: OK
导入 Postman(Github)
连接项目

获取更新(手动)
Github 项目更新之后,需要手动在 Postman 中拉取更新:

获取更新(自动)
也可以配置 GitHub Actions 自动化来实现自动推送。
禁止Vercel 自动构建
默认情况下,Vercel 会为推送到关联 Git 仓库的每个提交创建新部署和构建(除非跳过构建步骤)

可以通过更新 Git 设置中的 Ignored Build Step 为 Don't build anything,来禁用自动构建。
导入 Postman (本地项目)
导入本地 Folders,

本地项目会自动更新,无需格外配置。