操作ガイド 6 min read API Blueprintとは？入門ガイドはこちら！ API Blueprintは、開発者がWebAPIを明確に記述できるツールとして、人間が読みやすい構造でAPIドキュメントを表示し、データリソースとデータフォーマットを定義することもできます。この記事ではAPI Blueprintを利用して、WebAPIの記述とドキュメント化を行う方法を皆さんに紹介します。
操作ガイド 7 min read 無料ダウンロード｜Stoplight Studioデスクトップ版を Stoplight Studioの公式サイトでは、デスクトップ版を提供していません。本文では、Stoplight Studioのデスクトップ版のダウンロードとインストール方法を皆さんに紹介します。Stoplight Studioのデスクトップ版が必要となる場合は、ぜひこの記事の内容を参照してください。
操作ガイド 7 min read ガイド：Stoplight Stuidoの使い方、API設計やドキュメンテーションを行う Stoplight Studioは、API設計・ドキュメント作成・公開のためのツールとして、多くのユーザーはStoplight Studioを利用してAPIを設計したり、APIドキュメントを作成したりしています。本文では、Stoplight Studioの詳細の使い方を皆さんに紹介します。API設計やドキュメンテーションを行いたい場合は、本文の内容を参照して操作してください。
操作ガイド 7 min read Stoplight Studioとは？OpenAPI設計とドキュメンテーションツールのおすすめ Stoplight Studioは、API設計・ドキュメント作成・公開のためのツールですが、業界で最も有名なOpenAPIドキュメンテーションツールとして認識しても良いと思います。それでは、本文では、このStoplight StudioがAPIドキュメンテーションにおいての強みを消化した上、非常に使いやすいOpenAPI設計とドキュメンテーションツールを皆さんに紹介しようと思います。
操作ガイド 6 min read API仕様書（設計書）のテンプレートのおすすめ API仕様書は、APIの実現できる機能やAPIの使い方を説明するドキュメントとして、API開発において、API仕様書は必ず不可欠なことになります。それでは、API仕様書を綺麗に作成するには、どうしたらいいですか？本文では、API仕様書のテンプレートを皆さんに紹介します。また、を作成できる無料ツールを使って、API仕様書を綺麗に作成する方法をも一緒に解説していこうと思います。
操作ガイド 7 min read 解説：APIドキュメンテーションとそのやり方 APIドキュメンテーションは、非常に重要なプロセスになる原因として、そこにAPIの使用を理解し、正しく利用するための基礎情報が含まれているからです。本文では、APIドキュメンテーションの詳細情報を紹介した上、APIドキュメンテーションのやり方をもみなさんに紹介していこうと思います。
操作ガイド 5 min read PostmanでAPIドキュメント（Document）を作成する PostmanはAPIテスト用の定番ソフトとして、多くのAPI開発者に利用されています。テストの他、Postmanは、APIドキュメントの作成をもサポートできます。本文では、Postmanを使って、APIドキュメントを作成する方法を皆さんに紹介します。PostmanでAPIを設計してAPIドキュメントが必要となる場合は、ぜひ本文の内容を参照してください。
操作ガイド 3 min read HTTP APIとは？それをテストする方法を紹介 APIの中でHTTP APIが一番汎用されている種類になります。現在主流となっているREST APIもHTTP APIに属しています。それでは、HTTP APIとは何ですか？何か特徴がありますか？本文では、これらの問題を解明していきたいと思います。
操作ガイド 5 min read 完全ガイド：Swagger UIをローカルで利用する Swagger UIはSwagger Specification(OpenAPI Specification)で記述されたAPIドキュメントを視覚的に確認できるツールです。Swagger UIはオフラインとオンラインのバージョンをも提供してくれていますが、色々な原因でSwagger UIをローカルで利用する必要があります。本文では、Swagger UIをローカルで利用する方法を皆さんに紹介します。
操作ガイド 4 min read 詳細ガイド：Swagger APIドキュメントを作成する方法 Swagger（OpenAPI）は、APIの標準仕様として、一番多くの場合は、Swagger APIドキュメントを作成する必要があるのでしょう。本文では、SwaggerのAPIドキュメントを作成する方法を詳しく皆さんに紹介します。
操作ガイド 5 min read 解説：Swagger（OpenAPI）の 仕様書の書き方 SwaggerやOpenAPIは、API業界標準の仕様になります。API設計を標準化にしたりする必要がある場合、SwaggerやOpenAPI仕様書の書き方をマスタする必要があるのでしょう。本文では、SwaggerとOpenAPIの仕様書の書き方を皆さんに詳しく解説するので、必要な方は本文の内容を参照してください。
観点 2 min read YAMLとRAMLの違い｜YAMLとRAML互換ツールおすすめ APIを定義する時に、YAMLとRAMLなど、ややこしい用語がたくさんあります。この2つの用語は、非常に類似したものですが、大きな違いがあります。本文では、YAMLとRAMLとの違いを解説した上、RAMLをより汎用されているYAMLに変換する方法を皆さんに紹介しようと思います。
