APIドキュメントを実装と乖離させないために - Qiita

テクノロジーカテゴリーの変更を依頼記事元:

qiita.com

76users がブックマークコメント

コメント

6

記事へのコメント6件

注目コメント
新着コメント

vvakame ちょっと討論してみたいなーこれ。Google Discovery Based ServiceやSwagger、RAMLなど類似のアイディアのものがあるがなぜJSON Schema生なのか？

2014/09/16 リンク

tbpg “JSON Schema (とその周辺ツール) を利用せずとも同等の成果物を得ることは可能だが、利用する方がより短い時間で実現できるため利用している”

2015/07/15 リンク

takaesu APIドキュメント

2015/06/18 リンク

lizy XML SchemaからJSON Schemaへの進化？もうちょっと人に優しくならないものなのか

2014/09/18 リンク

mano-junki 設計　実装　api tips hack システム開発　json schema jsonschema フェーズ間設計

2014/09/16 リンク

marmotY HTTPを使ったデータ入出力と永続化の一種の究極系。行指向が良いのはバージョン管理しやすいから。マイグレーションのようにデータ形式そのもののバージョン管理も出来ると良い。

2014/09/16 リンク

vvakame ちょっと討論してみたいなーこれ。Google Discovery Based ServiceやSwagger、RAMLなど類似のアイディアのものがあるがなぜJSON Schema生なのか？

2014/09/16 リンク

注目コメント算出アルゴリズムの一部にLINEヤフー株式会社の「建設的コメント順位付けモデルAPI」を使用しています

規約違反を報告

アプリのスクリーンショット

いまの話題をアプリでチェック！

バナー広告なし
ミュート機能あり
ダークモード搭載

アプリをダウンロード

関連記事

{{ total_bookmarks_with_user_postfix }}{{ root_title }}

APIドキュメントを実装と乖離させないために - Qiita

内部用APIであるか外部の開発者向けのAPIであるかに関わらず、ドキュメントと実装との乖離は極力避けた... 内部用APIであるか外部の開発者向けのAPIであるかに関わらず、ドキュメントと実装との乖離は極力避けたいものであるが、注意深く開発を進めない限りこの状況は容易に起こり得る。何が乖離を引き起こし、どうすればこの状況を回避できるのか考えながら、JSON Schemaの利用例を紹介する。なおこの投稿では、HTTP経由でデータの通信を行うような狭義のAPIのことをAPIと呼ぶことにする。同じ情報源を参照する APIドキュメントと実装が同じ情報源を参照するようにすれば、論理的に関連した要素は統一的に変更され、これらの変更は完全に同期が取れたものになる。つまり、変更時に乖離が生じにくくなる。但し情報の見せ方によって乖離が発生する可能性は十分にだろうし、乖離が発生するのは理解しようとする側の認識の問題であるから、論理的に全く起こり得ないということではない。この参照の形には、両者が別の情報源を参照する

ブックマークしたユーザー

fuba2017/05/08
mi_kattun2017/03/17
teppey2016/02/18
nomnel2016/01/26
holidayworking2015/07/25
ymm1x2015/07/24
tbpg2015/07/15
takaesu2015/06/18
dorayakikun2015/06/11
moqada2015/05/28
kkabetani2015/05/13
TokyoIncidents2015/04/09
yaaamaaaguuu2015/02/27
rrreeeyyy2015/02/27
azuki_mihomiho2015/01/22
teracy_junk2015/01/16
at284km2014/11/15
astk_f2014/10/14

同じサイトの新着

同じサイトの新着をもっと読む

いま人気の記事

いま人気の記事をもっと読む

いま人気の記事 - テクノロジー

いま人気の記事 - テクノロジーをもっと読む

新着記事 - テクノロジー

新着記事 - テクノロジーをもっと読む

いま人気の記事 - 企業メディア

企業メディアをもっと読む

設定を変更しましたx