本日は、普段開発時に使っているAPIドキュメントテンプレートを共有します(今後様々なドキュメントテンプレートを共有していく予定です)。サービス開発の際にドキュメントはないがしろにしがちですが、大切なプロセスなので面倒でもきちんと書き起こしましょう。チームで開発する場合、ドキュメントが中心となりチーム全員の理解が統率されていきます。仕様変更時は、ドキュメントも随時更新して常に正しいものにしていく運用も大切です。・APIドキュメントに関しては、他の人に利用されるものなのでレベルの高いドキュメントが必要とされます。レベルが高いといっても複雑なものではなく、むしろ、できるだけ短く簡素かつわかりやすく書く必要があります。(API名を記載)APIの説明文を記載。APIの利用シーンと目的を記載すると、使う人にもわかりやすい。URLパラメーターリクエスト時に使えるパラメーターを記載。必須となるパラメターを記載。パラメーターはパスで渡すものクエリーで渡すものクッキーで渡すものがあります。明記してAPI利用者にわかりやすくしましょう。必須パラメーターと基本同じフォーマットで記載。データPOST時に渡すデータを記載。データのタイプとしてはapplication/jsonapplication/xmlapplication/x-www-form-urlencodedtext/plainmultipart/form-dataがあります。入力値エラーがおきないように各値のタイプや制限を明記しましょう。正常レスポンスコード200エラーレスポンスエラーレスポンスの一覧を記載。エラーコード一覧はこちらを参照:https://docs.microsoft.com/en-us/rest/api/storageservices/common-rest-api-error-codesサンプルコードサンプルコードを記載。ECXサイト編集部トランスコスモスのECX本部が運営するサービスサイト「ECX」編集部です。コーディング、WEBデザイン、SEM、UI改善などの実務経験豊富なメンバーで執筆・運営・管理をしております。Plus」の優れた成果を持つ提携企業として認定された、国内に7社しかいない(2021年9月時点)最上位の公式パートナーです。partner(ショッピファイプラスパートナー)」です。