ドキュメント·OpenAPIとPostman
⚙

OpenAPIとPostman

ライブOpenAPI仕様、Scalarビューア、Postmanコレクション——クライアント、モックサーバー、その他を生成。

OpenAPI仕様

正規のOpenAPI 3.1仕様は以下でライブ配信されています:

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

デプロイのたびに実際のルートハンドラーから再生成されるため、本番動作から逸脱することはありません。これを使って:

  • 任意の言語でクライアントを生成(openapi-generator-cli generate -i openapi.yaml -g python)
  • モックサーバーを起動(prism mock openapi.yaml)
  • CIで前回vendoredしたコピーとのdiffを取る

閲覧

Scalarビューアは仕様をインタラクティブなドキュメントとして以下でレンダリングします:

https://api.eveses.com/docs

ブラウザのauthボックスにAPIキーを貼り付けて、エンドポイントを直接試せます。

Postman

同じ仕様から生成されたコレクションをインポート:

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

環境変数 eveses_api_key と eveses_base_url が同梱されています。一度設定すれば、すべてのリクエストが事前入力されます。

バージョニング

現在の仕様は v1 です。v1エンドポイントは決して破壊しません——追加は後方互換です。将来の v2 は非推奨化の前に少なくとも12ヶ月、v1と並存します。

追加について通知を受けるには /changelog/api を購読してください。