文档·OpenAPI 和 Postman
⚙

OpenAPI 和 Postman

实时 OpenAPI 规范、Scalar 查看器、Postman 集合——生成客户端、mock 服务器,等等。

OpenAPI 规范

权威的 OpenAPI 3.1 规范在以下位置实时提供:

https://api.eveses.com/docs/openapi.yaml

每次部署时都会从实际的路由处理器重新生成,因此永远不会偏离生产行为。用它来:

  • 生成任何语言的客户端(openapi-generator-cli generate -i openapi.yaml -g python)
  • 启动 mock 服务器(prism mock openapi.yaml)
  • 在 CI 中与你上次 vendor 的副本做 diff

浏览

Scalar 查看器在以下位置将规范渲染为交互式文档:

https://api.eveses.com/docs

将你的 API 密钥粘贴到 auth box 中,直接在浏览器中尝试端点。

Postman

导入集合(从同一规范生成):

https://api.eveses.com/docs/eveses.postman_collection.json

它附带环境变量 eveses_api_key 和 eveses_base_url。设置一次,所有请求都会预填。

版本管理

当前规范是 v1。我们从不破坏 v1 端点——添加是向后兼容的。未来的 v2 将与 v1 共存至少 12 个月才会弃用。

订阅 /changelog/api 以获知添加。