0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

I/Fのパラメータ名は揃えるべき話

0
Posted at

はじめに

このエントリは、初挑戦カレンダー Advent Calendar 2025 の 18日目記事です。
https://qiita.com/advent-calendar/2025/silvia

今年、Twitterで何か主張したかったことを拾いながら記事を書いていきます。

そろそろいいネタが減ってきました。

本文

バックエンドと画面がワンセットの機能というのは近年の開発では減ってきており、
APIを作って、色々な呼び方をするというのが近年の開発スタイルだ。
私が現在関わっている案件も例に漏れず、REST APIを作って、モダンUIなフロントエンドからAPI叩いて機能実現というような開発を行っている。

そんな中で、設計書を見ていた私がとても落胆してしまう出来事があった。
タイトル回収、I/Fによって同じパラメータの名称が違っていたのである。

本来、同じソースを元にしたデータというのは同じ名称であるべきである。
名称が違うと、何でこっちではこの名前なのにあっちでは違う名前なの?違うものなの?と混乱してしまうからである。
そしてその手のI/Fを見てしまった開発者は、バックグラウンドの想像もせずになんだこのI/Fクソだな! と思ってしまうだろう。
何故なら私がそうだから。

実際確認してみたところ、異なる名称として定義したのには意味があった。
あったのだが、命名規則からは外れている、使う側(他システム)の都合、更には誰もその規則違反と戦っていないなど、やはり落胆することが多かった。

結構頑張ってシステムの統一感を出そうと頑張っていたのだが、こういうのを見るとちょっと疲れが出てしまうなあ。

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?