OpenAPI 仕様をオープンソース化

オートデスク SDK チームが、いくつかの REST API の OpenAPI 仕様 仕様をオープンソース化しています。OpenAPI は、REST API インターフェイスを記述するための仕様です。もし、APS の上に構築している場合には、APS API に対してこれまで以上に迅速に探索、統合、自動化出来るようになります。

OpenAPIとは?

OpenAPIは、RESTful API を機械可読形式(YAML または JSON)で記述するために広く採用されている標準です。APIのエンドポイント、リクエスト/レスポンス構造、認証方法などを、ツールと人間の両方が理解できる方法で定義することが出来ます。API がどのように機能するかの青写真のようなものです。

APS 開発者にとって重要な理由

OpenAPI 仕様にアクセスすると、例えば、次のようなことが可能になります。

  • ドキュメントを調査せずに、Postman などのツールを使用してエンドポイントをすばやく探索
  • お使いの言語でクライアント SDK を自動生成
  • AI および ローコード/ノーコード プラットフォームとの統合を自動生成
  • リクエスト/レスポンスを検証し、開発の早い段階でエラーをキャッチ

現在利用可能なリソース

現段階では、最も一般的に使用されるいくつかの APS API の OpenAPI 仕様を公開しています。今後、お客様のフィードバックに基づいてカバーする領域を拡大し、仕様を改善していく予定です。

 APS API の OpenAPI 仕様は、公式の GitHubリポジトリで公開されています。

次のステップ

これは、これらの OpenAPI 仕様の使用方法(SDK、Power Automate コネクタ、AI エージェントの生成など)の実際的な例を詳しく説明するブログ投稿シリーズの第1回です。

次回の投稿では、OpenAPI 仕様から Postman コレクションを生成して使用し、API テスト、コラボレーション、オンボーディングを効率化する方法をご紹介します。

いつものように、フィードバックをお待ちしております。次に必要な仕様や利便性を高める方法をお持ちであれば、ぜひ、共有いただければと思います。

※ 本記事は OpenAPI Specs Are Here! | Autodesk Platform Services から転写・意訳・補足したものです。

By Toshiaki Isezaki

Discover more from Autodesk Developer Blog

Subscribe now to keep reading and get access to the full archive.

Continue reading