時の流れは早く、今日で65歳になりました。

今年の3月で、40年間支払い続けてきた厚生年金保険料と会社勤めを終え、4月から個人事業主として業務委託でソフトウェア開発に従事しています。これまで保険料を支払う側だったのが、今は年金を受け取る側に変わりました。

コンピュータやプログラミングがどのようなものか全く知らなかった高校3年生の時に、情報工学科に進学すると決めて、九州工業大学情報工学科へ進学したのが1978年4月でした。それから、気がつけばもう46年が経ちました。もしあと4年、健康でソフトウェア開発を続けられれば、ちょうど半世紀になります。

何歳まで続けることができるか分かりませんが、これからもソフトウェア業界に対して微力ながら、貢献していければと思っています。

技術書の翻訳としては22冊目となる『Go言語で学ぶ並行プログラミング』の予約をAmazonで受付始めました。

まったく分類・整理していませんが、ランダムにWebサービスのバックエンドのAPI仕様に関する備忘録を書いていきたいと思います。

001 該当する定義が存在しない

問題：あるデータの一覧を返すエンドポイントの仕様に、「返されるデータはXXXYYYStatus順に返される」と記述されているのですが、そもそもXXXYYYStatusはどこにも定義されていない。

この記述を書いた本人は分かっているつもりなのかもしれませんが、第3者が読んだら理解できなくて問い合わせることになります。これは、記述した仕様が第3者が理解できるかという視点を持たないことによるものだと思われます。その視点で、自分で記述した仕様をレビューできる必要があります。

一般的にXXXYYYStatusというのはenumとして定義されている可能性があり、その場合、「XXXYYYStatus順」というのは、具体的に何順なのかが曖昧です。enumの個々の値の型としては、数値（gRPCなど）の場合もあれば、文字列の場合もあります。

「XXXYYYStatus順」というのは、おそらく次のことを意味していますが、明確に記述する必要があります。

• enumとして定義されている順

明確に順序を記述しておかないと、もし、個々の値が文字列であった場合、アルファベット順と解釈される可能性もあります。

はじめに

第1章　ソフトウェアテストの変遷
1.1　1990年代までと2000年代のソフトウェアテスト
　目視確認が普通だった
　自動テストの普及
　手動によるテストでは，ソフトウェアが腐る
1.2　フィードバックループを短くする
　テストとフィードバックループ
　テストとフィードバックループ
　テストファースト開発
1.3　ビッグバンインテグレーションから継続的インテグレーションへ
　ビッグバンインテグレーション
　夜間ビルド
　継続的インテグレーション
1.4　まとめ

第2章　API仕様
2.1　APIとは
　フレームワークや標準ライブラリのAPI仕様
　企業内でのAPI仕様
2.2　優れたAPI仕様とは
　理解が容易
　変更が容易
　テストが容易
2.3　API仕様でよくある問題点
　 API仕様が記述されていない
　エラーの説明が記述されていない
　 API仕様に基づく自動テストコードが存在しない
2.4　API仕様に書くべきこと
　サービスの概要の説明
　個々のエンドポイントの説明
　エラーの説明
2.5　API仕様とE2Eテスト
2.6　まとめ

第3章　gRPCにおけるAPI仕様の書き方
3.1　gRPCとは
3.2　API仕様をどこに書くか
3.3　サービスの概要の記述
3.4　個々のエンドポイント（RPC）の説明
3.5　エラーの説明
　パラメータの不正
　誤った順序での呼び出し
　認証や認可のエラー
　サービスの概要に書くべきそのほかのエラー
　個々のエンドポイントに書くべきそのほかのエラー
　書く必要がないエラー
3.6　リストオプションの説明
3.7　まとめ

第4章　API仕様ファースト開発
4.1　開発順序
　 API仕様の記述
　 E2Eテストフレームワークの検討と実装
　テストコードの作成と機能の実装
　リファクタリングとカバレッジの確認
　 Pull Requestのレビュー
4.2　不具合の修正順序
　再現テストの作成と実装の修正
　リファクタリングとカバレッジの確認
4.3　既存のエンドポイントの修正と新たなエンドポイントの追加
4.4　API仕様のエンドポイントを呼び出すE2Eテストの利点
4.5　まとめ

第5章　E2Eテストフレームワークの構築
5.1　テストフレームワークの基本的な考え方
　本番環境と同じバイナリ
　カバレッジの取得
5.2　マイクロサービス構成でのテストフレームワーク
　書きたいテスト
　 E2Eテストフレームワークのプロセス
　依存サービスが外部サービスの場合の解決方法
　エラーのテストは簡単
5.3　非マイクロサービス構成でのテストフレームワーク
5.4　E2Eテストフレームワークの骨格
　 Test Suiteプロセスの骨格
　テスト対象マイクロサービスの骨格
　フェイクマイクロサービスの骨格
　テストコードの骨格
　そのほかの考慮項目
5.5　まとめ

第6章　API仕様の技術的負債の返済
6.1　APIの技術的負債とは
　 E2Eテストフレームワークの構築が重要
　ソフトウェアエンジニアとしても重要
　ソフトウェア開発組織としての強い目標
6.2　API仕様の負債の返済
　既存のエンドポイントを修正するケース
　新たなエンドポイントを追加するケース
　既存のエンドポイントの不具合を修正するケース
6.3　返済順序のまとめ
6.4　E2Eテストのもう1つの利点：リファクタリング
6.5　E2Eテストと単体テスト
　 E2Eテストは必須
　テストデータの準備
　データの準備でつまずく
6.6　API仕様ファースト開発が定着した組織
6.7　まとめ

第7章　Go言語によるE2Eテストフレームワークの実装
7.1　E2Eテストの基本的な流れ
　 Test Suiteプロセスの流れ
7.2　courierライブラリの構成とインストール
　インストールと動作確認
7.3　サンプルサービスの構成と定義
　サンプルサービスの構成
　 Shopサービスの.protoファイル
　.protoファイルのコンパイル
　サンプルサービスで実現したいテスト
7.4　E2Eテストコードの例
　 InvalidArgumentエラーのテストコード
　 newShopClient()関数の実装
　テストの実行
7.5　E2Eテストフレームワークの流れ
　フェイクサービスの実行
　テスト対象サービスの起動
　テスト対象サービスの準備待ち
　テストの実行
　テスト対象サービスの終了
7.6　フェイクサービスの構築
　フェイクサービスの自動生成
　自動生成されたフェイクサービスのコード
7.7　テスト実行までの流れとテストコードの実装
　 TestMain関数
　テスト対象サービスが依存する環境変数
　テスト対象サービスの呼び出しとテストの実行
　 Makefile
　テスト関数の実行
　テスト終了の通知
　カバレッジの表示
7.8　テストの並列化サポート
　 TIDの伝搬
7.9　ほかのテスト関数の例
　 DeadlineExceededエラー／Canceledエラー
　正常ケース
　 SetListProductInventoriesResponseCreator
7.10　テスト関数に合格するサーバ実装
7.11　外部サービスのフェイクサービス
　 Google PubSubのPublisherサービス
　 REST APIのサービス
7.12　E2Eテストでのデータの準備
　エンドポイント経由でのデータ準備の利点
7.13　ステージング環境や本番環境に対するE2Eテスト
7.14　まとめ

付録A　Goのテストの並列化
　複数パッケージのテストを並列に実行する
　 t.Parallel()メソッド
　並列化での注意点
　まとめ

付録B　長時間夜間ランニングテスト
　過去の経験
　長時間ランニングテスト
　まとめ

付録C　防御的プログラミング
　防御的プログラミングとは
　防御的プログラミングとAPI仕様

発売日は、多少変動するかもしれませんが、私にとって6冊目となる自著です。

『WEB+DB PRESS Vol.134』で書いた特集記事1に加筆・修正したものです。さらに、過去に講演で話した内容やいくつかのTech Blogも加筆・修正したものを含めています。

私が翻訳した以下の書籍は、Kindle版が購入可能な時期もありましたが、現在は販売終了になっており、購入できません。

技術書の翻訳本は20冊以上行ってきましたが、自分で執筆する本は2012年9月に出版した『"プログラマー"まだまだ"現役続行』が最後でした。紙の本は絶版ですが、Kindle版やPDF版で今でも読むことができます。


最終的な発売日は未定ですが、14年ぶりに自著としての技術書を出版します。内容は、58歳から経験してきたWebサービスのバックエンドサービスに関して、「API仕様ファースト開発」をまとめたものとなります。

「4月から（少し）働きます」では、会社勤めを終えて、個人事業主として働くということを書きました。その時点は、業務委託で少し働く予定でした。しかし、フルタイムで働いていないので、業務委託で働くことを打診されて、働くことになりました。次の2社で業務委託でソフトウェア開発に従事します。

• Digital Platformer（2024年4月1日〜）
• カウシェ（2024年4月22日〜）

どちらも自宅からのフルリモートです。稼働時間としては、両社で週に4.5日程度になりそうですので、ほぼフルタイムになります。

社会人になって40年間続けた会社勤めを終えて、4月から個人事業主として開業届を出しました。初めてのことなので、どこから学んでいけばよいのか分からなかったので、とりあえず読み始めた本の中の1冊です。個人的には、インボイス制度のところは今もモヤッとはしていますが、マンガで税について説明してくれており、とても読みやすくお勧めの本です。

ただ、以下の点も書いてあると良かったかなと思います。

• 国民健康保険を役所の窓口で行うと、その場で健康保険証をもらえること
• 個人事業主の開業届では、必ず税務署の受領印が押された開業届の控えを持っておくこと

健康保険証

会社勤めとして9社で働いた経験からすると、転職するごとに新たな会社が属している健康保険組合に変更になります。その際に、新たな健康保険証が届くのが1、2週間後ということがほとんどです。そのため、国民健康保険も健康保険証の発行に時間を要すると勝手に思い込んでいたのですが、横浜市青葉区の区役所の窓口に申請書類を提出したら、その場で発行（印刷）されて、持って帰ることができました。

個人事業主の開業届の控え

個人事業主の開業届ですが、別の書籍で開業届けの控えが必要な場合があることが書かれていたので、税務署まで行って、受領印が押された控えをもらってきました。

この本で紹介されている「小規模企業共済」への申し込みには、個人事業主としての確定申告書の控えが必要なのですが、開業当初はそのようなものはありません。その場合、小規模企業共済のホームページには「事業を始めたばかりで確定申告書がない場合：開業届の控え」と書かれていました。

4月から知り合いの会社の開発組織を手伝うということで、週に2日あるいは3日、リモートで働きます。

令和トラベルを退職して行ったこととして、以下のことを行いました。

• 国民健康保険の手続き
• こどもの国のウィークデーパスポートの購入

40年間の会社勤めで、会社を変わるごとに健康保険証が届くのに1週間以上を要していたので、同じように時間を要するのかなと思っていました。でも、実際は違っていました。

郵送での申請でも可能なのですが、必要書類を準備してから横浜市青葉区の区役所へ出向いて、保険年金課で申請しました。申請したら、その場で国民健康保険の健康保険証が発行されて、もらって帰ることができました。

こどのも国のそばに暮らし始めてから20年以上が経過していますが、今までは数えるほどしか行ったことがありませんでした。普段の心臓リハビリテーションとしては、天気が悪い日は家でエアロバイク、天気が良い日はウォーキングをしててきたのですが、仕事しながらだとどうしても朝10時のミーティングに間に合うようにしないといけませんでした。

これからは、時間的に余裕があるので、ウォーキングコースにこどもの国を入れたいと思い、こどもの国の「ウィークデーパスポート」（3,000円/年）を購入しました。


申し込み書と代金を窓口に出すと、引き換え証をもらえるので、それで入園できます。帰りに案内所で引き換え証と交換でウィークデーパスポートをもらえます。

こどもの国は水曜日は休園日なので、実質的に週4日しか使えません。ただ、季節によっては水曜日も休園しない日があります。