agreed-typed ҏ౻ɹӯ

ࣗݾ঺հ • ҏ౻ɹӯʢ͍ͱ͏ɹ͖͋ͱʣ • @akito0107 • 2015೥ ϦΫϧʔτೖࣾ • ιϑτ΢ΣΞΤϯδχΞ • Go / Node.jsΛॻ͍͍ͯ·͢

͸ͳ͢͜ͱ • RTCͷΑ͋͘ΔΞʔΩςΫνϟ • AgreedͱConsumer-Driven Contract • Agreed-Typed • ·ͱΊ

from: https://speakerdeck.com/yosuke_furukawa/rikurutotekufalserozizufalseji-shu-dong-xiang?slide=11

No content

No content

͜͜

͍ͭ΋ ͜͜Ͱ ݂͕ྲྀ ΕΔ

APIͷI/Fʹؔ͢Δ໰୊ • ୭͕͍ܾͭΊΔ໰୊ • Backend͕উखʹܾΊͯFront͔Β͸࢖͍ͮΒ͍ (ex, N + 1 http requestͳͲ) • ϝϯςφϯεਏ͍໰୊ • DocumentͱͷෆҰகɺͦ΋ͦ΋DocͳͲͳ͍ɺ etc…

Agreed • https://github.com/recruit-tech/agreed • Consumer-Driven Contract&Specification By Exampleͷπʔϧ • APIΛ࢖͏ଆʢFEʣ͕request / responseΛJSONͳͲͰ
 ࣗ༝ʹࢦఆͰ͖Δ • FEͷͨΊʹ͸Mock Serverͱͯ͠ৼΔ෣͏ • BEͷͨΊʹ͸E2E testing toolsͱͯ͠ৼΔ෣͏

Agreed Sample • agreed.js

Agreed Server Sample • Run Server • curl

Agreed fileͷදݱྗͷ໰୊ • Agreed͸FE͕खܰʹmock serverΛཱͯΔͨΊͷ࢓૊Έ • Agreed fileΛਖ਼͘͠ॻ͘͜ͱࣗମ͕೉͍͠ • ex) ඞਢɾඇඞਢΛදݱͰ͖ͳ͍, ύϥϝʔλͷൈ͚͕ ݕ஌Ͱ͖ͳ͍ͳͲ • agreedͰrequest / responseΛఆٛͯ͠΋ɺFE/BEͰਖ਼ ͘͠ॲཧͰ͖ͯΔ͔Λ֬ೝ͢Δํ๏͕ͳ͍

agreed-typed • Agreed fileͷAPIఆٛʹܕΛ͚ͭΔͨΊͷϥΠϒ ϥϦ • APIΛܕͰදݱ • requestͷPath΋ܕ, responseͷstatusCode΋ܕ • agreedͷఆٛΛ੩తղੳ͢Δ

agreed-typed sample 1 • APIDef<>͔ΒͷܕΤΠϦΞεͰAPIΛఆٛ

agreed-typed sample 2 • ܕʹैͬͯexampleΛఆٛ

agreed-typed sample 3 • Run Server • curl

agreed-typed sample 4 • ͍Ζ͍ΖͳܕνΣοΫΛ͔͚ΒΕΔ ະఆٛͷCPEZ ૝ఆ͞Εͳ͍
 TUBUVTDPEF QBUI͕ؒҧͬͯΔ

ଞʹ΋ίϯύΠϥ͕νΣοΫͰ ͖Δ͜ͱ • GETʹbody͚ͭΔͱίϯύΠϥౖ͕Δ • Status codeʹΑΓbodyग़͠෼͚ • etc…

Future of API design • Specification by example or 
 Specification by design • Consumer / Producerͷඇରশੑ • ܕͰAPIΛදݱ͠ɺਖ਼౰ੑΛίϯύΠϥ͕ݕূ͢Δ ੈք͕དྷΔ • Haskell servant / Protobuf

·ͱΊ • agreedͱconsumer driven contractͷ঺հ • agreed-typedͷ঺հ • APIఆٛΛܕͰදݱ͠Α͏

͋Γ͕ͱ͏͍͟͝·ͨ͠