タグ

ドキュメントとapiに関するtuneのブックマーク (1)

  • Documentation Driven Contractsについて調べてみた - mookjp.io

    Documentation Driven Contractsについて調べてみた May 15, 2017 ( May 15, 2017 更新 ) モチベーション 最近業務で、社内の他のチームに提供するAPIを開発している。 関わっている人が少なければ、みんなで近くに座って都度仕様について相談していけばいい。(感覚的には〜7人くらい?) しかし、会社全体の人数が多く、関わるチームも複数いるため(サービスのモバイルアプリ担当、Webフロント担当、バックエンド担当…など)包括的で都度更新されるドキュメントがないと開発効率が悪い。 とはいえ、API提供チームとしては、実装になるべく多くの時間を使いたい。具体的には以下の条件を満たす手法があればよい: ドキュメント作成にかける時間を短くできる 作成したドキュメントの内容が正確(最新であることが必須) 一番原始的な手法として、ドキュメントをちまちま人手

  • 1