PostmanにてAPI仕様を実験的に提供開始

概要

タノミマスターはOpenAPI Specification形式でAPI仕様を公開しています。しかしながら、OpenAPI Specification形式の仕様をAPI利用者が見やすいフォーマットで表示するツールが少ないのが現状です。

API利用者にとって利便性の高いPostmanにてAPI仕様を公開致しました。

PostmanはAPIのテストと開発を支援するツールで、API開発者やテストエンジニアに欠かせない存在として知られています。

https://and-engineer.com/articles/ZPHmqRQAALFikRPH#heading2-1

使い方

以下のURLから仕様書を閲覧できます。

https://www.postman.com/matsubo/workspace/tanomimaster-b2b-order-management-platform/overview

利点

• 見た目がわかりやすい。高機能。
• Web上からリクエストを発行できる。
• 外部からのAPIテストを定期的に行える。

欠点

• ベンダーロックインが発生してしまう。
• OpenAPI Specificationファイルとの同期が行えない。

運用

当面は、以前と変わらずOpenAPI Specification形式での仕様提供を行います。

注意

• APIの利用にはAPIキーの発行が必要です。
• APIキーを発行するためにはタノミマスターの利用登録が必要です。
• タノミマスターの利用登録はこちらから行えます。