committee-railsとOpenAPI Generatorでスキーマ駆動なAPI開発をする

Fusic Tech Live Vol.13：Rubyistの集い Vol.2
2023-04-027 Thu. 20:25-20:45
https://fusic.connpass.com/event/276617/

Transcript

1. גࣜձࣾ'VTJD*P5νʔϜ
   Ԭቌ༤ฏ
   'VTJD5FDI-JWF7PM3VCZJTUͷू͍7PM
   DPNNJUUFFSBJMTͱ0QFO"1*(FOFSBUPSͰ
   

   εΩʔϚۦಈͳ"1*։ൃΛ͢Δ📝
   

   View Slide

2. ࣗݾ঺հ
   
   •
   ॴଐ
   • גࣜձࣾ'VTJD*P5νʔϜ
   • ϑΟϤϧυϒʔτΩϟϯϓϝϯλʔ
   •
   ܦྺ
   • ؔ੢Ͱ૊ࠐΈΤϯδχΞ ʙ
   
   • ෱ԬͰ8FCΫϥ΢υΤϯδχΞ ʙ
   
   •
   ೝఆࢿ֨
   *P5Ϋϥ΢υΤϯδχΞ
   Ԭ ቌ ༤ ฏ
   0 L B [ B L J : V I F J
   ʘ
   /&8
   ʗ
   

   View Slide

3. 3VCZPO3BJMTΛ࢖ͬͨҊ݅4FOTPS$PSQVT*$
   
   • $0ηϯαʔΛ༻͍ͨײછ঱ରࡦ*P5ιϦϡʔγϣϯ
   • ηϯαʔ஋Λ"84ʹऔΓࠐΈɺμογϡϘʔυʹՄࢹԽ
   • ͜ͷμογϡϘʔυΛ3VCZPO3BJMTͰ։ൃ
   IUUQTJOGPDPSQVTDPKQQVSQPTFTFOTPSDPSQVTJD
   IUUQTGVTJDDPKQXPSLT
   

   View Slide

4. 3VCZPO3BJMTΛ࢖ͬͨҊ݅NPDLNPDL
   
   • *P5։ൃʹ͓͚ΔςετΛࢧԉ͢Δ'VTJDͷࣗࣾϓϩμΫτ
   • σόΠεͷ୅ΘΓʹσʔλΛૹ৴Ͱ͖ɺ਺΍ߏ଄Λࣗ༝ʹม͑ΒΕΔ
   • ίϯιʔϧը໘Λ3VCZPO3BJMTͰ։ൃ
   IUUQTNPDLNPDLDPN
   

   View Slide

5. 3VCZPO3BJMTΛ࢖ͬͨҊ݅/JDPMF
   
   • ࣾ಺χίχίΧϨϯμʔγεςϜ 'VTJDͷࣾ಺γεςϜ
   
   • /FYUKTͱ3VCZPO3BJMTΛ࢖ͬͨ41"Ͱ͋Γɺ3BJMT͸"1*ϞʔυͰ࡞͍ͬͯΔ
   • ࠓ೔͓࿩͢Δ಺༰ͱ࠷΋਌͍͠ߏ੒
   IUUQTUFDIGVTJDDPKQQPTUTOJDPMFSFOFXBM
   

   View Slide

6. લఏ
   
   • ຊ೔͓࿩͢Δ"1*͸શͯ8FC"1*Λࢦ͠·͢
   • 3&45GVM"1*Λ૝ఆ͓ͯ͠࿩͠·͢
   • ࣗ෼΋ϕετϓϥΫςΟεΛ໛ࡧ͍ͯ͠Δͱ͜ΖͰ͢
   •
   ΋ͬͱྑ͍ํ๏΍πʔϧ͕͋Ε͹ͥͻϑΟʔυόοΫ͍ͩ͘͞🙏
   

   View Slide

7. ໨࣍
   
   3BJMTͰ"1*
   "1*εΩʔϚ
   "1*ͷςετ
   ΫϥΠΞϯτίʔυࣗಈੜ੒
   ·ͱΊ
   

   View Slide

8. 3BJMTͰ"1*
   

   View Slide

9. 3BJMTͰ"1*Λ࡞ͬͨ͜ͱ͸͋Γ·͔͢ʁ🙋
   

   View Slide

10. "1*Λ࡞ΔγνϡΤʔγϣϯ
    
    • 'VTJDͷडୗҊ݅͸ۀ຿γεςϜ͕ଟ͍
    • 3BJMTͷϨʔϧʹ৐Δํ͕ߴ඼࣭ͳ΋ͷΛޮ཰తʹ։ൃͰ͖Δ
    IUUQTGVTJDDPKQXPSLT
    

    View Slide

11. "1*Λ࡞ΔγνϡΤʔγϣϯ
    
    • ͦΕͰ΋"1*Λ࡞ΔγνϡΤʔγϣϯ͸͋Δ
    • 6*69Λॏࢹ͢΂͘41"Ͱ։ൃ͢Δͱ͖
    • ϞόΠϧΞϓϦΛఏڙ͢Δͱ͖
    • ଞγεςϜͱ࿈ܞ͢Δͱ͖
    • ඇಉظͰσʔλΛड͚౉͍ͨ͠͠ͱ͖
    • FUD
    "1*αʔό
    6*69ॏࢹͷ
    ϑϩϯτΤϯυ
    ϞόΠϧΞϓϦ
    ଞγεςϜ
    

    View Slide

12. "1*ʹ͓͚Δ೰Έ
    
    ϑϩϯτΤϯυͱόοΫΤϯυͰ
    ࢓༷ͷෆҰக͕ى͜Γ͕ͪ
    +BWB4DSJQUͱ3VCZͰ
    

    ໋໊نଇ͕ҧ͏
    DSFBUFE@BU͔DSFBUFE"U͔
    
    3BJMT͚ͩͰ࡞ΔΑΓ΋
    ࣮૷ྔ͕େ͖͘ͳΔ
    ೝূͲ͏͢Δʁ ϖʔδωʔγϣϯ΍ݕࡧͲ͏͢Δʁ
    "1*Λ܁Γฦ͠ݺͿ͜ͱͰ
    ϖʔδͷද͕ࣔ஗͘ͳΓ͕ͪ
    

    View Slide

13. "1*ʹ͓͚Δ೰Έ
    
    ϑϩϯτΤϯυͱόοΫΤϯυͰ
    ࢓༷ͷෆҰக͕ى͜Γ͕ͪ
    +BWB4DSJQUͱ3VCZͰ
    

    ໋໊نଇ͕ҧ͏
    DSFBUFE@BU͔DSFBUFE"U͔
    
    3BJMT͚ͩͰ࡞ΔΑΓ΋
    ࣮૷ྔ͕େ͖͘ͳΔ
    ೝূͲ͏͢Δʁ ϖʔδωʔγϣϯ΍ݕࡧͲ͏͢Δʁ
    "1*Λ܁Γฦ͠ݺͿ͜ͱͰ
    ϖʔδͷද͕ࣔ஗͘ͳΓ͕ͪ
    

    View Slide

14. ϑϩϯτΤϯυͱόοΫΤϯυͰ࢓༷ͷෆҰக͕ى͜Γ͕ͪ
    "1*εΩʔϚΛॻ͍ͯෆҰகΛ๷͙
    

    View Slide

15. "1*εΩʔϚ
    

    View Slide

16. ΠϯλʔϑΣʔε࢓༷ΛܾΊΔ͜ͱͷॏཁੑ
    
    • ෳ਺ͷߏ੒ཁૉ͔Β੒ΓཱͭγεςϜΛ࡞Δࡍͷమଇ
    • ·ͣΠϯλʔϑΣʔε࢓༷ΛܾΊΔ
    ߏ੒ཁૉ" ߏ੒ཁૉ#
    ΠϯλʔϑΣʔε
    

    View Slide

17. ΠϯλʔϑΣʔε࢓༷ΛܾΊΔ͜ͱͷॏཁੑ
    
    • ΠϯλʔϑΣʔε࢓༷͕ܾ·͍ͬͯͳ͍ͱ
    • ૒ํ͕ಠࣗղऍͰ֤ϞδϡʔϧΛ࡞ͬͯ૊Έ߹Θͤͨͱ͖ʹ໰୊͕ੜ͡Δ
    • ૊Έ߹ΘͤΔ·Ͱ໰୊͕ݦࡏԽ͠ͳ͍ͷͰɺඞવతʹख໭Γ͕େ͖͘ͳΔ
    • ੹೚ͷॴࡏ͕ᐆດʹͳΓɺϞϝΔ
    ߏ੒ཁૉ" ߏ੒ཁૉ#
    NPPE ؾ෼
    ͔ͩΒ
    จࣈͰ౉ͤ͹͍͍ͩΖ͏
    NPPE͸FOVNͷ஋Λ
    ਺ࣈͰ౉ͯ͘͠ΕΔͩΖ͏
    1045BQJWOJLPT
    \
    lNPPEzlHPPEz
    lEBUFzlz
    ^
    

    View Slide

18. "1*ʹ͓͚ΔΠϯλʔϑΣʔε࢓༷ʹ"1*εΩʔϚ
    
    • "1*εΩʔϚʹॻ͔ΕΔ৘ใ
    • 8FC"1*͕ఏڙ͢ΔΤϯυϙΠϯτ
    • "1*͕ఏڙ͢ΔϦιʔε
    • ϦΫΤετ͓ΑͼϨεϙϯεͷܗࣜ
    • ͳͲ
    ΫϥΠΞϯτ
    ϑϩϯτΤϯυ
    
    "1*
    όοΫΤϯυ
    
    1045BQJWOJLPT
    \
    lNPPEzlTUSJOHz
    lEBUFzlTUSJOHz
    ^
    "1*εΩʔϚ
    

    View Slide

19. "1*εΩʔϚͷॻ͖ํ
    
    • 3&45GVMͳ"1*Ͱ͋Ε͹0QFO"1*͕Ұൠత
    • :".-͔+40/Ͱॻ͘
    • 4UPQMJHIU4UVEJP౳ͷπʔϧΛ׆༻͢Δͱָ
    

    View Slide

20. "1*ͷςετ
    

    View Slide

21. ςετ͕ඞཁͳཧ༝
    
    • ࢓༷ʹԊ࣮ͬͨ૷Ͱ͋Δ͔Λ֬ೝ͢ΔͨΊ
    ΫϥΠΞϯτ
    ϑϩϯτΤϯυ
    
    "1*
    όοΫΤϯυ
    
    1045BQJWOJLPT
    \
    lNPPEzlHPPEz
    lEBUFzlz
    ^
    \
    lJEz
    lNPPEzlHPPEz
    lEBUFzlz
    lVTFS@JEz
    lDSFBUFE"Uz5
    lVQEBUFE"Uz5
    ^
    εΩʔϚʹͦͬͨϦΫΤ
    ετΛड͚෇͚Մೳ͔ʁ
    εΩʔϚʹԊͬͨϨεϙ
    ϯε͕ฦͬͯ͘Δ͔ʁ
    

    View Slide

22. ςετࣗମ͸γϯϓϧ
    
    • ࣮ࡍʹϦΫΤετͯ͠ɺظ଴ͨ͠Ϩεϙϯε͕ฦΔ͜ͱΛ֬ೝ͢Ε͹ྑ͍
    • ϨεϙϯεσʔλΛࣄࡉ͔ʹ֬ೝ͢Δͷ͸େม
    • ຊདྷฦͯ͠͸͍͚ͳ͍σʔλ͕͍ࠞͬͯ͡Δ͜ͱʹؾ͖ͮʹ͍͘
    ΫϥΠΞϯτ "1*
    1045BQJWOJLPT
    \
    lNPPEzlHPPEz
    lEBUFzlz
    ^
    \
    lJEz
    lNPPEzlHPPEz
    lEBUFzlz
    lVTFS@JEz
    lDSFBUFE"Uz5
    lVQEBUFE"Uz5
    ^
    ͦΕͧΕνΣοΫ͢Δͷ͸େม
    

    View Slide

23. DPNNJUUFFSBJMT
    
    • DPNNJUUFFͱ͍͏HFNΛ3BJMTʹ૊ΈࠐΈ΍ͨ͘͢͠΋ͷ
    • 0QFO"1*ͷεΩʔϚ௨ΓͷϨεϙϯε͕དྷ͍ͯΔ͔νΣοΫͰ͖Δ
    

    View Slide

24. σϞ
    
    • ͜Μͳײ͡ͷςετίʔυΛॻ͘
    DPNNJUUFFSBJMT͕ఏڙ͢ΔBTTFSUϝιου
    

    View Slide

25. σϞ
    
    • ฦ͍ͯ͠ΔϨεϙϯε
    • ςετ݁Ռ
    ຊདྷฦ͢΂͖NPPEΛ๨Ε͍ͯΔ
    NPPE͕ͳ͍͜ͱΛࢦఠͯ͘͠ΕΔ
    

    View Slide

26. σϞ
    
    • ฦ͍ͯ͠ΔϨεϙϯε
    • ςετ݁Ռ
    εΩʔϚʹ͸ଘࡏ͠ͳ͍,FZΛฦ͢
    EVNNZ͕εΩʔϚʹ͸ଘࡏ͠ͳ͍
    ͜ͱΛࢦఠͯ͘͠ΕΔ
    

    View Slide

27. ΫϥΠΞϯτίʔυࣗಈੜ੒
    

    View Slide

28. ΫϥΠΞϯτͷίʔυ
    
    • +BWB4DSJQUͷ৔߹9.-)UUQ3FRVFTU౳Λ࢖͏͜ͱͰॻ͚Δ
    • "1*͝ͱʹ͜ΕΛॻ͘ͷ͸େม
    • 5ZQF4DSJQUΛॻ͘ͱ͖ͷܕఆ͕ٛେม
    

    View Slide

29. 0QFO"1*(FOFSBUPS
    
    • 0QFO"1*ͷεΩʔϚΛݩʹίʔυΛࣗಈੜ੒Ͱ͖Δ
    • ܕఆٛ΋ࣗಈੜ੒Ͱ͖Δ
    

    View Slide

30. σϞ
    
    • PQFOBQJHFOFSBUPSDMJίϚϯυΛ࣮ߦͯ͠ɺίʔυΛࣗಈੜ੒
    

    View Slide

31. σϞ
    
    • ੜ੒͞ΕͨΫϥΠΞϯτΛར༻ͨ͠ίʔυ
    

    View Slide

32. ·ͱΊ
    

    View Slide

33. "1*ͷ։ൃ͸εΩʔϚۦಈͰ
    
    • όοΫΤϯυ͸ςετͰεΩʔϚ௨Γͷ࣮૷Λ୲อ
    • ϑϩϯτΤϯυ͸ࣗಈੜ੒ͰεΩʔϚ௨Γͷ࣮૷Λ୲อ
    ΫϥΠΞϯτ
    ϑϩϯτΤϯυ
    
    "1*
    όοΫΤϯυ
    
    1045BQJWOJLPT
    \
    lNPPEzlTUSJOHz
    lEBUFzlTUSJOHz
    ^
    "1*εΩʔϚ
    ςετ
    ࣗಈੜ੒
    0QFO"1*
    DPNNJUUFFSBJMT
    0QFO"1*(FOFSBUPS
    

    View Slide

34. ࢿྉ࡞੒ʹ࢖ͬͨιʔείʔυ
    
    • IUUQTHJUIVCDPNZVVVOJLP@BQJ
    

    View Slide

35. 5IBOLZPV
    'VTJDͰ͸*P5ͰੈͷதΛΞοϓσʔτ͚ͭͮ͠Δ
    

    ΤϯδχΞΛืू͍ͯ͠·͢
    IUUQTSFDSVJUGVTJDDPKQ
    

    View Slide