1.前回記事
前回記事はこちらです。
システム開発時の詳細設計書系ついて①（画面設計書について）
https://qiita.com/yu-F/items/1b7510d6f43707b09535
システム開発時の詳細設計書系ついて②（ ビジネスルールについて）
https://qiita.com/yu-F/items/7c9323d1f6c8121f8bf0
システム開発時の詳細設計書系ついて③（ API設計書について）
https://qiita.com/yu-F/items/6fda33fdb4cd328aeeb9
詳細設計書としての必要な資料一式について
① 画面設計書（画面のレイアウト＋部品の説明＋DBの付き合わせ）
② 画面に対してのビジネスルール
③ API設計書
④ OpenAPIを使用してのSwagger EditorのIF設計書
今回は「④ OpenAPIを使用してのSwagger EditorのIF設計書」について書きます。
2. Swagger EditorのIF設計書について
当設計書については、RestAPI用のOpenAPIを事前に作成する必要があります。
OpenAPIの書き方については標準のもののため、ここでは割愛します。
作成物として、API一覧で用意したものをOpenAPIとしてそれぞれ作成する必要があります。
（BFF,BEともに）
下記は例として準備した内容となります。
openapi: 3.0.0
info:
title: 顧客検索API
description: １週間においての顧客ごとの情報を検索するBFF
version: 1.0.0
servers:
- url: https://localhost:8080
description: 顧客検索API
paths:
/shukanKyokyakuJohoSearch:
get:
operationId: getShukanTalentJohoSearch
summary: １週間においての顧客ごとの情報を返す
description: １週間においての顧客ごとの情報を返す
parameters:
- in: query
name: userId
required: false
schema:
type: string
responses:
'200':
description: 正常終了
content:
application/json:
schema:
$ref: '#/components/schemas/kokyakuJoho'
components:
schemas:
kokyakuJoho:
description: １週間においての顧客情報
type: object
properties:
kokyakuId:
type: string
description: 顧客ID
kokyakuName:
type: string
description: 顧客名
３. 実例
２で用意したOpenAPIをIFの設計書に見立てて、Swagger EditorのIF設計書を表示します。
① VsCodeでプラグインとして、「Swagger Viewer」をインストールします。
② ２で用意したOpenAPIを開きます。
③ Ctrl + Shift + Pで、「Preview Swagger」をクリックします。
④ 右側にIFの設計書が表示されるようになります。
※各項目の解説についてはSwaggerEditorで標準のもののため、割愛します。
４. 終わりに
４回に渡る記事にて詳細設計書の書き方について説明しましたが、現場により本当にバラバラのため、ベストというものはないと思っております。
しかし統一して、言えることはPGがこれを見るとシステム開発ができるということは絶対となります。
私はこれから作成するシステムの課題をこれらのフォーマットに落としたのでそれを元に9月まで開発を進めていく予定です。
長きにわたり、詳細設計書シリーズを書いてきましたがこれにて終了します。
ありがとうございました。