catch-img

【解説】APIドキュメント(テンプレート)

本日は、普段開発時に使っているAPIドキュメントテンプレートを共有します(今後様々なドキュメントテンプレートを共有していく予定です)。

サービス開発の際にドキュメントはないがしろにしがちですが、大切なプロセスなので面倒でもきちんと書き起こしましょう。特にチームで開発する場合、ドキュメントが中心となりチーム全員の理解が統率されていきます。仕様変更時は、ドキュメントも随時更新して常に正しいものにしていく運用も大切です。設計時に書き起こした仕様書が全く(よくも悪くも進化した)システムと合っていなくて意味がない・・・、なんていうシーンはあるあるですね・・ ・

APIドキュメントに関しては、他の人に利用されるものなのでレベルの高いドキュメントが必要とされます。レベルが高いといっても複雑なものではなく、むしろ、できるだけ短く簡素かつわかりやすく書く必要があります。


(API名を記載)

APIの説明文を記載。APIの利用シーンと目的を記載すると、使う人にもわかりやすい。


URL(APIの相対パス)


メソッド

GET | POST | DELETE | PUT のいずれかを記載。


URLパラメーター

リクエスト時に使えるパラメーターを記載。

必須パラメーター

必須となるパラメターを記載。 パラメーターは

  • パスで渡すもの
  • クエリーで渡すもの
  • クッキーで渡すもの

があります。明記してAPI利用者にわかりやすくしましょう。

オプションパラメーター

必須パラメーターと基本同じフォーマットで記載。

データ

POST時に渡すデータを記載。データのタイプとしては

  • application/json
  • application/xml
  • application/x-www-form-urlencoded
  • text/plain
  • multipart/form-data

があります。入力値エラーがおきないように各値のタイプや制限を明記しましょう。


正常レスポンス

コード200


エラーレスポンス

エラーレスポンスの一覧を記載。エラーコード一覧はこちらを参照: 

https://docs.microsoft.com/en-us/rest/api/storageservices/common-rest-api-error-codes


サンプルコード

サンプルコードを記載。cURLを使ってAPIを使う方法はこちらを参照:https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/Developers/GettingStarted/API%20requests/curl-requests.htm


備考

備考を記載 。


ECXサイト編集部
ECXサイト編集部
トランスコスモスのECX本部が運営するサービスサイト「ECX」編集部です。コーディング、WEBデザイン、SEM、UI改善などの実務経験豊富なメンバーで執筆・運営・管理をしております。

採用情報(求人)


Shopifyアプリ解説・紹介記事

ShopifyのECサイト制作ならトランスコスモス

トランスコスモスは、Shopifyのエンタープライズ版「Shopify Plus」の優れた成果を持つ提携企業として認定された、国内に7社しかいない(2021年9月時点)最上位の公式パートナーです。

Shopifyを使ったECサイト制作から、調査分析・戦略立案、WEB広告(SEM)、ECサイト制作、お客様サポート、受発注、フルフィルメントまで業務設計・運用代行いたします。


トランスコスモスのEC全領域を網羅するサービス



Shopify問い合わせフォーム

関連記事


【無料】セミナー動画視聴


EC関連サービス


数字で見るトランスコスモスの強み

お気軽に
お問い合わせください

Shopify(ショッピファイ)
ECストア構築・運用代行

トランスコスモスは日本に7社しかない最上位の「Shopifyプラスパートナー」企業です
shopify専用倉庫スピードロジ

Shopify人気記事ランキング

 Tag(タグ)

 記事検索

 カテゴリー

 【無料】募集中セミナー

正社員募集(求人)

 【無料】資料ダウンロード

Shopify認定パートナー企業

トランスコスモスは日本に7社しかない最上位の「Shopifyプラスパートナー」です。
Shopifyでのサイト制作ならお任せください