自分で開発するAPIを公開したい場合は、API仕様をドキュメントにとして公開するのは共通の方法になると思います。本文では、一番簡単なAPI管理ツールを使って、API仕様書を自動生成して、サードパーティの公開APIマケットに公開する方法を皆さんに紹介します。
APIを公開する理由
事業拡大、エコシステムの構築など、様々な理由によって、APIを公開する必要があります。次は、なぜかAPIを公開するといった主な理由は以下でまとめてみます。
事業拡大
APIを公開することで、開発者はアプリやサービスを構築することができます。これにより、企業の製品やサービスの利用が広がり、ビジネスを拡大できる可能性があります。
オープンイノベーションを推進
APIを公開することで、開発者コミュニティから新しいアイデアやアプリケーションが生まれる可能性があります。これにより製品開発の幅が広がります。
エコシステムを構築
APIと連携するパートナー企業を増やすことで、自社のプラットフォームの価値を高めることができます。パートナー各社の強みを活かしたサービス提供が可能になります。
収益源
APIの利用に課金することで直接的な収入を得ることができます。あるいは、APIの利用を通じて製品やサービスの認知度や利用が高まり、結果的に収益が上がることも期待できます。
業界標準を作る
自社のAPIを業界標準にすることで、事実上のプラットフォームとなり、競争優位性を確立できる可能性があります。
それでは、いずれかの理由で自分が開発したAPIを公開したい場合は、どうしたらいいですか？次は、API公開のやり方を皆さんに紹介していきたいと思います。
完全解説：APIを公開する方法
自分が開発できたAPIを公開したい場合、一番共通の対策は、APIの仕様をドキュメントにして、公開することになります。つまり、分かりやすいAPIの仕様書を作成するのがポイントです。このような場合、API仕様書は、API公開の媒介として機能しています。API仕様書を他人に共有したり、公開プラットフォームでリリースしたりすることで、APIを一般大衆に公開することが実現されます。
API公開のスタート：API仕様書の作成
API仕様書は、APIの使い方を詳しく説明する文書になります。API仕様書を読んでいたら、APIのエンドポイント、必須のパラメータ、レスポンスのフォーマットなどの情報を手に入れることができます。ユーザーは、API仕様書を参照して、APIエンドポイントにリクエストを送信して、情報を取得したり、添削したり、変更したりすることができます。
次は、非常に分かりやすくて読みやすいAPI仕様書のサンプルです。このAPI仕様書は、API管理ツールのApidogを使って自動生成されたものになります。次は、Apidogを使用して、API仕様書を生成する方法を詳しく紹介します。
ステップ⒈Apidogを開き、新しいAPIを作成して、HTTPメソッド、APIエンドポイントのURLなどを設定します。
ステップ⒉必須のパラメータなどの基本情報を記入します。
ステップ⒊レスポンスのデータ（レスポンスのデータ構造と具体的なレスポンス例）を定義します。
ここで、基本的なAPI仕様書が作成されます。また、自分のニーズに従って、このAPI仕様書にエラーコードや相応のレスポンスを定義することもできます。Apidogで以上のように直感的なUIで手動でAPI仕様書を作成できるのだけではなく、すでに利用可能なAPIなら、APIにリクエストを送信してレスポンスを取得すると、その結果をAPI仕様書として保存することができるので、非常に便利です。
APIを一般大衆に公開する
上記の対策を参照して、API仕様書を作成・自動生成すると、そのAPI仕様書を公開のプラットフォームにリリースすると、APIを一般大衆に公開することができますね。
shimizu chioka
ここでAPI HUBという公開APIマケットを皆さんにおすすめします。API Hubは利用可能なサードパーティのAPIをまとめるWebサイトです。このサイトでは、なんと1800個強のAPIが掲載されています（2023年5月現在）。各APIをクリックすると、具体的なAPI詳細ページが表示され、そのページで直接にリクエストを送信することもできるので、非常に便利です。
ApidogでAPI仕様書を生成すると、「共有」→「公開設定」→「公開する」の順にクリックすると、簡単にAPIをAPI HUBで公開できます。
また、コミュニティ、ブログ、自社サイトでAPI仕様書を公開することも、APIを一般公開することに繋がります。これらでAPI仕様書を公開することは、技術情報にアクセスできる人なら誰でもそのAPIが利用できる状態になりますが、API公開の範囲を制限したい場合は、アクセス可能な人を限定するなどの対策が求められます。例えば、コミュニティはメンバー限定にしたり、ブログやサイトの特定ページへのアクセスを制限するといった方法が考えられます。
いずれにせよ、API仕様書の公開方法と公開範囲について、API提供側の方針に沿って適切に判断することが重要だと思います。一般公開になることを認識した上での検討が必要でしょう。
