OpenAPI仕様(OAS)とは

OpenAPI仕様(OAS)は、REST APIの標準のプログラミング言語にとらわれないインターフェース記述を定義しています。これにより、人間とコンピューターの両方が、ソースコードへのアクセス、追加資料、ネットワークトラフィックの検査を必要とせずにサービスの機能を発見および理解できます。 。 OpenAPIを介して適切に定義されている場合、コンシューマは最小限の実装ロジックでリモートサービスを理解し対話することができます。 低レベルのプログラミングのためにインターフェース記述が行ったことと同様に、OpenAPI仕様はサービスを呼び出す際の当て推量を取り除きます。

旧来の名前がSwaggerですした、3.0へバージョンアップしたとき、OAS(OpenAPI Specification)に名前が変更されました。しかし、現在のツールの名前がSwaggerの名前をつけるのはほとんどです。

Swaggerのツール群

  • Open Source Tools

    1. Swagger Editor

      OpenAPI仕様でAPIを設計するためのAPIエディタ

    2. Swagger UI

      対話型UIでOpenAPI仕様定義を視覚化する

    3. Swagger Codegen

      OpenAPI仕様の定義からサーバースタブとクライアントSDKを生成する

  • Pro Tools

    1. SwaggerHub

      OpenAPI仕様を扱うチームや個人のための設計およびドキュメンテーションプラットフォーム。

      ※ 個人なら、無料で使えますので、ぜひ使ってみてください。 https://swagger.io/tools/swaggerhub/pricing/

    2. Swagger Inspector

      ブラウザからAPIを簡単にテストして試し、すぐにOpenAPI仕様の定義を生成します。

参照資料

spec資料