JSON Schema で Web API のスキマを托めよう
- 1. JSON Schema で Web API のスキマを托めよう 今析圻虻o (@co3k)
- 2. クライアントg廾サ`バg廾 碧 Web API にありがちなこと API ドキュメント リクエストレスポンス ぶっちゃけAPI の弖紗rく らいしか厚仟していない なぜかドキュメントにない奉來が 根まれている 返が錆ってドキュメントと飛孤`う侘塀の 奉來を根めちゃったけどなんとなく宥った
- 3. クライアントg廾サ`バg廾 碧 いまは API Blueprint でBってる? (http://apiblueprint.org/) API ドキュメント リクエストレスポンス Markdown の? ス`パ`セット (ツラい) API Blueprint (YAML 燕F) generate mockvalidate あんまり耙しく ない なんかeに JSON Schema かない といけない
- 4. クライアントg廾サ`バg廾 碧 書晩したいこと JSON Schema API ドキュメント リクエストレスポンス generate validatevalidate API 碧の DSL ドキュメントが碧に弖 していることを隠^ 秘薦I尖のg廾が碧に 弖惄靴討い襪海箸魃Ｔ^ 竃薦I尖のg廾が碧に 弖惄靴討い襪海箸魃Ｔ^
- 5. クライアントg廾サ`バg廾 碧 (まだ) o尖だった JSON Schema API ドキュメント リクエストレスポンス generate API 碧の DSL ドキュメントが碧に弖 していることを隠^
- 6. JSON Schema ? リソ`スや attribute、 JSON を喘いた API について燕F することができるフォ`マット (http://json-schema.org/ documentation.html) ? JSON Schema Core ? JSON Schema Validation ? JSON Hyper-Schema
- 7. JSON Schema $ curl https://api.heroku.com/ schema -H "Accept: application/vnd.heroku+json; version=3"
- 8. Validation (嚠協) ? JSON Schema 碧に児づく validate 喘ライブラリは冱 Zわず遣るほどあるはずなのでそれを聞えばよい ? 秘薦も JSON Schema でバリデ`ションするようにすれば (ある殻業の) 秘薦編^は徭蛍でかなくてもgむ ? 竃薦は JSON Schema のバリデ`ションに宥るかどうかだ け_Jすれば (ある殻業の) テストは徭蛍でかなくても gむ
- 9. Documentation ? prmd で伏撹するのがオススメ ? Heroku の API ドキュメント喘に恬られた ? JSON Hyper-Schema から GitHub Markdown を竃薦し てくれる ? erb 侘塀のテンプレ`トで竃薦をカスタマイズ辛嬬 ? 今析圻も contribute している
- 13. interagent/committee ? Rack middleware to validate responses according to JSON schema? ? JSON スキ`マに児づくレスポンスのバリデ`ションをする Rack ミドルウェア
- 14. interagent/schematic ? Generate Go client code for HTTP APIs described by JSON Hyper-Schemas.? ? JSON Hyper-Schema によって峰された HTTP API の Go クライアントを伏撹する
- 15. interagent/http-api-design ? HTTP API design guide extracted from work on the Heroku Platform API? ? Heroku Platform API の撹惚麗から塗伏した HTTP API の Oガイド ? 恍晩の 25 rになぜか才Uをはじめた https:// github.com/co3k/http-api-design/tree/translate- japanese
- 16. interagent/heroics ! ! ? Ruby HTTP client for APIs represented with JSON schema? ? JSON スキ`マによって燕Fされた API のための Ruby HTTP クライアント
- 17. クライアントg廾サ`バg廾 碧 まとめ JSON Schema API ドキュメント リクエストレスポンス generate validatevalidate API 碧の DSL ドキュメントが碧に弖 していることを隠^ 秘薦I尖のg廾が碧に 弖惄靴討い襪海箸魃Ｔ^ 竃薦I尖のg廾が碧に 弖惄靴討い襪海箸魃Ｔ^
- 18. Question?