# API設計

API管理ツールのApidogを使って、APIを効率よくデザインしたり、作成したりする方法など、APIの設計に関する役立つ記事の集合です。
観点 3 min read

API制限とは?制限の種類、原因などを完全に解説

X(Twitter)のAPI制限により、多くのユーザーがサービスを正常に利用することができなくなります。それでは、このAPIの制限はなんでしょうか?なぜか多くのサービスプロバイダーでも制限を設けていますか?本文では、APIの制限を完全に解説した上、その原因をも探りたいと思います。
API制限とは
観点 4 min read

APIのレスポンス型を解説:簡単にレスポンスを定義する方法はこちら

現在、APIリクエストを送信して取得してきたレスポンスは大部JSONになっていますね。それでは、JSONとは別に、他のレスポンス型がありませんか?本文では、JSONを含む様々なレスポンス型を解説した上、これらの型のレスポンスを簡単に定義する方法を皆さんに紹介していこうと思います。
APIのレスポンス型
操作ガイド 7 min read

ガイド:Stoplight Stuidoの使い方、API設計やドキュメンテーションを行う

Stoplight Studioは、API設計・ドキュメント作成・公開のためのツールとして、多くのユーザーはStoplight Studioを利用してAPIを設計したり、APIドキュメントを作成したりしています。本文では、Stoplight Studioの詳細の使い方を皆さんに紹介します。API設計やドキュメンテーションを行いたい場合は、本文の内容を参照して操作してください。
Stoplight Stuidoの使い方
操作ガイド 7 min read

Stoplight Studioとは?OpenAPI設計とドキュメンテーションツールのおすすめ

Stoplight Studioは、API設計・ドキュメント作成・公開のためのツールですが、業界で最も有名なOpenAPIドキュメンテーションツールとして認識しても良いと思います。それでは、本文では、このStoplight StudioがAPIドキュメンテーションにおいての強みを消化した上、非常に使いやすいOpenAPI設計とドキュメンテーションツールを皆さんに紹介しようと思います。
Stoplight Studioとは
操作ガイド 6 min read

API仕様書(設計書)のテンプレートのおすすめ

API仕様書は、APIの実現できる機能やAPIの使い方を説明するドキュメントとして、API開発において、API仕様書は必ず不可欠なことになります。それでは、API仕様書を綺麗に作成するには、どうしたらいいですか?本文では、API仕様書のテンプレートを皆さんに紹介します。また、を作成できる無料ツールを使って、API仕様書を綺麗に作成する方法をも一緒に解説していこうと思います。
API仕様書(設計書)のテンプレートのおすすめ
操作ガイド 7 min read

解説:APIドキュメンテーションとそのやり方

APIドキュメンテーションは、非常に重要なプロセスになる原因として、そこにAPIの使用を理解し、正しく利用するための基礎情報が含まれているからです。本文では、APIドキュメンテーションの詳細情報を紹介した上、APIドキュメンテーションのやり方をもみなさんに紹介していこうと思います。
APIドキュメンテーション
操作ガイド 5 min read

PostmanでAPIドキュメント(Document)を作成する

PostmanはAPIテスト用の定番ソフトとして、多くのAPI開発者に利用されています。テストの他、Postmanは、APIドキュメントの作成をもサポートできます。本文では、Postmanを使って、APIドキュメントを作成する方法を皆さんに紹介します。PostmanでAPIを設計してAPIドキュメントが必要となる場合は、ぜひ本文の内容を参照してください。
PostmanでAPIドキュメント

Apidogのニュースレターを購読する

今すぐ購読すると、いつでもApidogから更新情報と最新観点を手に入れることができます。