設計 開発・基盤

外部設計 PART4 APIインターフェース仕様設計書

  1. HOME >
  2. 開発・基盤 >
  3. 設計 >

外部設計 PART4 APIインターフェース仕様設計書

概要

PART3の続きになります
外部設計の中でデータベース設計・テーブル定義書について説明しました。

今回はAPIインターフェース仕様についてになります。

APIインターフェース仕様設計書

APIを使う開発であればこのドキュメントが一番、開発者が目にするのではないかと思います。最近の開発はAPIを中心としたものがメインになっています。理由はWebだけでなくiPhoneやAndroidの開発をするときにAPIが必要になるからです。

最近ではVueやReactといったJavascriptがAPIを取得できるのでWebもAPIとの相性がよく使われています。実際にAPIインターフェース仕様書はどういったものか説明していきます。

API一覧

どのようなAPIがあるのかを紹介します。基本的には以下のように「Get「Post」「Put」「Delete」の4つのトランザクションを使用します。

Get 温度取得 /temperature
Post 温度登録 /temperature
Put 温度更新 /temperature
Delete 温度削除 /temperature

エンドポイント

エンドポイントはどこか。つまりURLのパスは何かが記載されています。
API一覧の例のように/temperatureというようにパスです。
具体的には以下のようになります。

天気情報API 取得

リクエストレスポンス

リクエストパラメータは何でレスポンスパラメータは何なのか。成功したのか失敗したのかはHTTPステータスパラメータを返すことができます。
そのことがこと細かく記載してあります。

Swagger

最近ではSwaggerというツールがAPIインターフェース仕様書として使われています。
Swaggerを使うと実際にリクエストパラメータを送るとレスポンスデータが返ってくる用に作られているので実際に疎通できるかどうか確認することができ大変便利です。
私自身もよく使う仕様書です。
また、SwaggerのAPI仕様書を作成するときも、最近は仕様書を書くときにはプログラミングを書くときにアノテーションを書きます。
そのアノテーションでSwaggerドキュメントを作成することができます。
サーバーサイドエンジニアとしてやっていて、API仕様書を作っているんですが作成しているという気になっておらず、
勝手に作成しているような感じがしています。

次回予約

次回はネットワーク構成図について記載します。

前回までの外部設計


システム設計
外部設計 PART2 画面設計と遷移図 ビジネスロジック

外部設計について今回の第2部は画面遷移図、画面設計書、ビジネスロジックについて説明していきます。画像を取り入れながらどのように作成していけば効率的なのかを解説していきます。

続きを見る


システム設計
外部設計 PART1 方針設計書

システム開発における外部設計とは何か。どのような成果物があるのかを説明していく予定です。第1部は外部設計とは何かと方針設計についての説明をしています。

続きを見る

システムエンジニアランキング 仮想通貨ランキング にほんブログ村 IT技術ブログへ にほんブログ村 IT技術ブログ IT技術メモへ にほんブログ村 IT技術ブログ Webエンジニアへ

-設計, 開発・基盤

Copyright© スリーネクスト , 2020 All Rights Reserved.