本トピックではISSUE DocumentのAPI設計時のコミュニケーションツールとしての利用方法をご紹介します。

概要

画面設計機能を利用したAPI設計コミュニケーション

効果

• 開発現場でばらつきがちなAPI設計フォーマットの統一
• 画面設計書、API設計書として納品

事前準備

ページの画像のアップロードする

Figmaの画像データや該当ページのスクリーンショットを画面設計書ページでアップロードします。

画像アップロード前

画像アップロード後

API設計

API情報の追加

画像上のAPI情報が必要な箇所を押下して、「API」を選択します。

API情報の記載

APIの情報を入力して、作成を押下します。

API情報の閲覧

画面設計書ページ、またはAPI一覧から入力したAPI情報を確認できます。

画面設計書ページ

API一覧ページ

以上がAPI設計の利用方法になります。
API情報とは別にコメントも残すことができるので、PM・PdM、フロントエンドエンジニアとバックエンドエンジニア間でのコミュニケーションフォーマットとしてもご利用いただけます。