OpenAPI Specification (OAS) の次世代バージョンが正式にリリースされたことを発表できることを嬉しく思います!
OAS 3.0は、オリジナルのSwagger 2.0仕様に基づいており、業界がRESTful APIを定義し記述する方法を統一するための標準フォーマットを提供することを目的としています。OAS 3.0のリリースは、APIエコノミーの成長における重要なマイルストーンであり、オープンかつ透明な方法で、世界中のAPI開発者と消費者のニーズを満たすために仕様を進化させるために、業界全体の協力者を集めています。
SmartBear Software は、2015年にSwaggerチームがSmartBearに加わった際、Swagger 2.0 SpecificationをOpenAPI Initiativeに寄贈しました。APIの設計、ドキュメント作成、開発に仕様を頼るAPIプロバイダーが、OAS 3.0でAPI開発をさらに進めることができるのを楽しみにしています。
OpenAPI 3.0の新機能について詳しく知るには、9月26日に開催される無料トレーニング「OpenAPI 3.0: 最新のOpenAPI Specification 3.0でAPIを設計・ドキュメント化する方法」にご参加ください。
OAS 3.0の新機能は?
OAS 3.0の開発は、OpenAPI技術開発委員会とOAIの27名のメンバーだけでなく、この取り組みに貢献し、プルリクエストを送信し、フィードバックを提供して仕様の進化を推進した数千人の開発者とアーキテクトにとっても、真に協力的な取り組みでした。
今後数週間のうちにOAS 3.0に関する新しいリソースとトレーニングを多数リリースする予定ですが、今のところ3.0で期待できる新しいアップデートと機能の概要を以下に示します。
- 仕様の全体的な構造が再利用性向上のためにリファクタリングされました
- コールバック記述のサポートが追加されました
- 操作間の関係を表現するためのリンク
- JSONスキーマには、oneOf、anyOf、notのサポートが含まれています
- スキーマを使用する機能を含む、改善されたパラメータ記述
- マルチパート文書処理のサポートが向上しました
- Cookieパラメータは利用可能になりました。dataFormパラメータは廃止されました。
- ボディパラメータには独自のエンティティがあります
- コンテンツタイプ交渉のサポートが向上しました
- セキュリティ定義が簡素化され、強化されました
これはSwaggerにとって何を意味するのでしょうか?
新しい名前で新しい仕様がリリースされることが、Swaggerの将来にとって何を意味するのかについて、多くの質問がありました。6年以上にわたって仕様に関するツールを開発してきたチームとして、Swaggerプロジェクトは、OASをより良く実装するための高品質なツール群であり続けます。
Swaggerが開発したツールには、Swagger UIとSwagger Editorがあります。Swagger UIは、OpenAPI Specification(旧Swagger Specification)に命を吹き込み、ユーザーがAPIを読みやすく理解しやすい形式で視覚化し、操作できるようにしました。もう一つの人気のあるオープンソースプロジェクトであるSwagger Editorは、OpenAPI SpecificationでAPIを設計するための事実上のオープンソースエディタです。これらは、開発者と消費者がOASを活用できるように、Swaggerが開発と成長を続けている多くのツールのほんの一部です。
これらのツールやその他のSwaggerプロジェクトを進化させ、OAS 3.0の力を最大限に引き出すために、引き続き投資していきます。今後数週間のうちに、さまざまなSwaggerツールへの3.0サポートの提供時期、およびSwaggerHubプラットフォームにとって3.0が何を意味するのかについて、さらに詳しくお伝えします。さらに、今後数週間、数ヶ月、数年で、チームからエキサイティングな新しいSwaggerプロジェクトがリリースされることを期待してください!
OAS 3.0はSwagger 2.0を使用するAPIにとって何を意味するのでしょうか?
短期的には何もありません。Swagger 2.0は、Swaggerのツール、SwaggerHub、または2.0仕様をサポートするその他のプラットフォームで引き続き使用できます。当面の間、2.0仕様の使用を引き続きサポートします。
現在、3.0への移行プロセスを支援するツールを開発中ですので、今後の展開にご注目ください。
詳細はこちら:APIにOpenAPI 3.0を作成したいですか?Swagger Inspectorがあなたをサポートします
OAS 3.0についてどこで学べますか?
ここSwaggerでは、OpenAPI Specificationを非常に重視しており、人々が何が起こっているのかをさらに学ぶためのリソースを常に作成しています。以下は、私たちのお気に入りのOAS 3.0リソースのリストです。
OAS 3.0の新機能については、GitHubのOAI 3.0ドキュメントも参照することをお勧めします。
OpenAPI Initiativeからの完全な発表はこちらで読むことができます。
OpenAPI 3.0を使い始める
SwaggerHubでOpenAPI 3.0を使用して、新規および既存のAPIの設計とドキュメント作成を開始できます。SwaggerHubエディターでは、OpenAPI 3.0を使用してAPIを定義および視覚化したり、Swagger 2.0で定義された既存のAPIを仕様の最新バージョンに変換したりできます。Swagger Inspectorを使用すると、既存のAPIからOAS 3.0定義を簡単に生成することもできます。詳細については、OpenAPI 3.0への移行:Swaggerツールで既存のAPIを変換する方法をご覧ください!