OpenAPI
オープンAPI仕様
OpenAPI Specification Swagger OAS
Definition
REST APIのエンドポイント、入力、出力、認証方式を機械可読に記述する仕様。
OpenAPIは、REST APIの仕様をYAMLやJSONで記述するための標準フォーマット。旧称のSwaggerとして呼ばれることもある。
OpenAPI仕様が公開されていると、APIドキュメント、クライアントSDK、テストコード、型定義を自動生成しやすい。AIエージェントやFunction CallingにAPIを渡すときも、入力項目やレスポンス形式を機械的に理解しやすくなる。
SaaSを比較するときは、APIがあるかだけでなく、OpenAPI仕様が最新に保たれているか、破壊的変更が管理されているかも重要。
SaaSを比較するときは、単に「APIあり」と書かれているかではなく、読み取りだけか書き込みもできるか、認証方式、レート制限、Webhook、SDK、サンプルコードの有無まで確認するとよい。AIエージェントや自動化ツールから使う場合は、仕様が機械可読で、エラー内容がわかりやすく、権限を細かく分けられるほど扱いやすい。
注意したいのは、画面でできる操作がAPIでも同じようにできるとは限らない点。連携前提で導入するなら、必要なデータ項目を取得できるか、更新できるか、監査ログに残るかを事前に確認しておくと後戻りが少ない。