BEAR.SundayにおけるAPIドキュメントと整合性の担保 by 斉藤裕気

PHPerKaigi 2019
LT

BEAR.SundayにおけるAPIドキュメントと整合性の担保

gamu1012 斉藤裕気 gamu1012
7

APIを開発する際にSwaggerなどを用いてAPIドキュメントを書くことも多いかと思います

ですが、放置するとすぐにドキュメントは腐っていき、APIとドキュメントの内容に差異がでます

腐ってしまったドキュメントはときにドキュメントが存在しないことより厄介です

では、どうやってドキュメントの内容を担保するべきでしょうか?

このLTではBEAR.SundayにおけるAPIドキュメントと整合性の担保についてお話します