OpenAPI Generator Meetup #1

OpenAPI Generator Meetup #1 で発表した資料です！
https://openapi-generator-meetup.connpass.com/event/168187/

Transcript

1. த໺
   ڿਓ
   
   ΞεΫϧגࣜձࣾ
   
   0QFO"1*
   (FOFSBUPS
   .FFUVQ
    0QFO"1*
   (FOFSBUPS
   .FFUVQ ʙਓྨ૯ίϯτϦϏϡʔλԽܭըʙ
2. 8FCΞϓϦέʔγϣϯΤϯδχΞ த໺
   ڿਓ IUUQTBDLJOUPTIHJUIVCJPBCPVU BDLJOUPTI /","/0@"LJIJUP
3. 044׆ಈ w0QFO"1*
   (FOFSBUPS
   wIUUQTHJUIVCDPN0QFO"1*5PPMTPQFOBQJHFOFSBUPS
   w(BOFTIB
   Ψωʔγϟ
   wIUUQTHJUIVCDPNBDLJOUPTIHBOFTIB
   w4OJEFM
   εφΠσϧ
   wIUUQTHJUIVCDPNBDLJOUPTITOJEFM
4. OpenAPI Generator Meetup #1 https://openapi-generator-meetup.connpass.com/event/168187/
5. ໨࣍ ͍ΖΜͳ಺༰͕ࠞͬͨ͟
   ࡶଟͳൃදͰ͢
   w Θͨ͠ͷ0QFO"1*
   (FOFSBUPS׆༻ঢ়گ
   w 0QFO"1*υΩϡϝϯτΛ࢖ͬͯࠓޙ΍Γ͍ͨ͜ͱ
   w 4QSJOH
   $MPVE
   $POUSBDU
   0QFO"1*
   w 0QFO"1*
   (FOFSBUPSͷ࠷ۙͷτϐοΫΛ͝঺հ
   w υΩϡϝϯταΠτ͕Ξοϓσʔτ
   w )BOEMFCBSTʹରԠ
   w ΧελϜςϯϓϨʔτΤϯδϯʹରԠ
   w PQFOBQJTUZMFWBMJEBUPSϦϙδτϦ
   w ,VCFSOBUFTͷ3&45
   "1*ΫϥΠΞϯτੜ੒πʔϧͱͯ͠࠾༻͕ਐΜͰ͍Δ
   w ͓ΘΓʹ
6. Θͨ͠ͷ OpenAPI Generator׆༻ঢ়گ
7. ͱ͋ΔγεςϜ ϑϩϯτ
   αʔό ഑ૹ ঎඼ ސ٬ ஫จ "1* ,PUMJO
   4QSJOH
   #PPU
   4QSJOH
   8FC'MVY ,PUMJO+BWB
   4QSJOH
   #PPU
   4QSJOH
   .7$ 0QFO"1* "1*࢓༷ ͦͷଞ
8. ഑ૹ ঎඼ ސ٬ ஫จ ,PUMJO
   4QSJOH
   #PPU
   4QSJOH
   8FC'MVY ,PUMJO+BWB
   4QSJOH
   #PPU
   4QSJOH
   .7$ "1*࢓༷ ͦͷଞ "1* ͱ͋ΔγεςϜ
   
   0QFO"1*
   (FOFSBUPSͷ׆༻ঢ়گ ϑϩϯτ
   αʔό ϑϩϯταʔόͰ࢖͏
   ϞσϧΫϥεͷੜ੒͚ͩ 0QFO"1*
   
9. ໨࣍ w Θͨ͠ͷ0QFO"1*
   (FOFSBUPS׆༻ঢ়گ
   w 0QFO"1*υΩϡϝϯτΛ࢖ͬͯࠓޙ΍Γ͍ͨ͜ͱ
   w 4QSJOH
   $MPVE
   $POUSBDU
   0QFO"1*
   w 0QFO"1*
   (FOFSBUPSͷ࠷ۙͷτϐοΫΛ͝঺հ
   w υΩϡϝϯταΠτ͕Ξοϓσʔτ
   w )BOEMFCBSTʹରԠ
   w ΧελϜςϯϓϨʔτΤϯδϯʹରԠ
   w PQFOBQJTUZMFWBMJEBUPSϦϙδτϦ
   w ,VCFSOBUFTͷ3&45
   "1*ΫϥΠΞϯτੜ੒πʔϧͱͯ͠࠾༻͕ਐΜͰ͍Δ
   w ͓ΘΓʹ Ұ୴
   0QFO"1*
   (FOFSBUPS
   ͔Β
   ࿩͕୤ઢ͠·͢
10. APIͷςετΛ ࣗಈੜ੒͍ͨ͠
11. 8&# %#
    1SFTT
    WPM
    εΩʔϚۦಈ
    8FC
    "1*
    ։ൃ IUUQTHJIZPKQNBHB[JOFXEQSFTTBSDIJWFWPM ୈষ
    0QFO"1*ʹΑΔεΩʔϚۦಈ։ൃ
    ʮεΩʔϚΛ༻͍ͯ࢓༷ͱ࣮૷ͷҰகΛࣗಈςετ͢Δʯ 3VCZ
    PO
    3BJMTͰ࣮૷ͨ͠"1*αʔόͷϨεϙϯε͕ɺ 0QFO"1*υΩϡϝϯτͱဃ཭͍ͯ͠ͳ͍͔Λࣗಈςετ͢Δ ࣮૷Λ঺հ͍ͯ͠Δɻ
    ར༻͞Ε͍ͯΔϥΠϒϥϦ
    
    34QFD
    
    PBT@QBSTFS
    
    KTPO@TDIFNB
    
    $PNNJUUFF
12. Spring Cloud Contract (SCC) ͦ͜Ͱ… ʹ໨Λ͚ͭ·ͨ͠
13. 4QSJOH
    $MPVE
    $POUSBDU
    4$$ w4QSJOH
    $MPVE
    $POUSBDU͸$%$ ˞ ͷ࣮ફΛαϙʔτ͢Δπʔϧ
    w"1*ʹظ଴͢ΔڍಈΛ
    l$POUSBDUz
    ʹهड़͢Δ
    wˠ
    ʮϦΫΤετ
    999
    Λ౤͛ͨΒɺϨεϙϯε
    :::
    Λฦ͢ʯ
    wهड़ͨ͠$POUSBDU͔Βελϒαʔό΍ςετΛࣗಈੜ੒Ͱ͖Δ
    w ˞ $%$
    
    $POTVNFS%SJWFO
    $POUSBDUT
    EFWFMPQNFOU
    w IUUQXXXTFSWJDFEFTJHOQBUUFSOTDPN8FC4FSWJDF&WPMVUJPO$POTVNFS%SJWFO$POUSBDUT
    w "1*ར༻ऀ͕ظ଴͢ΔڍಈΛυΩϡϝϯτԽ͢Δ
    
    $POUSBDU
    w "1*ར༻ऀఏڙऀͷ૒ํ͕$POUSBDUΛ΋ͱʹςετΛߦ͏͜ͱͰ඼࣭Λอͪͳ͕ΒχʔζΛຬͨ ͢։ൃΛߦ͏
    IUUQTHJUIVCDPNTQSJOHDMPVETQSJOHDMPVEDPOUSBDU
14. 4QSJOH
    $MPVE
    $POUSBDU
    4$$ $POUSBDU
    (SPPWZ
    %4- ࣗಈੜ੒͞ΕΔςετίʔυ "1*ͷ࢓༷Λهड़ͨ͠$POUSBDU͔ΒςετίʔυΛࣗಈੜ੒ͨ͠ྫ
15. Spring Cloud Contract OpenAPI ͜Ε͸͏·͘࢖͑ͦ͏ɺͱ͍͏͜ͱͰ Λ։ൃதͰ͢
16. 4QSJOH
    $MPVE
    $POUSBDU
    0QFO"1*
    ಈ࡞Πϝʔδ 0QFO"1*υΩϡϝϯτ 4QSJOH
    $MPVE
    $POUSBDU
    0QFO"1* 0QFO"1*υΩϡϝϯτ
    ˠ
    $POUSBDUͷΦϒδΣΫτ
    ʹม׵ ςετίʔυ ೖྗ ग़ྗ
17. 4QSJOH
    $MPVE
    $POUSBDU
    0QFO"1* w0QFO"1*υΩϡϝϯτͷఆ͔ٛΒ4QSJOH
    #PPUͷςετίʔυΛࣗಈੜ੒͢Δ (SBEMF.BWFOϓϥάΠϯ
    w಺෦Ͱɺ0QFO"1*υΩϡϝϯτ͔Β$POUSBDUʹม׵͍ͯ͠Δ
    wઈࢍ։ൃதͰɺ·ͩ·࣮ͩ༻·Ͱ͸ԕ͍ʜ
    IUUQTHJUIVCDPNBDLJOUPTITQSJOHDMPVEDPOUSBDUPQFOBQJ IUUQTHJUIVCDPNBDLJOUPTITQSJOHDMPVEDPOUSBDUPQFOBQJTBNQMF * αϯϓϧίʔυ * ϦϙδτϦ
18. ໨࣍ w Θͨ͠ͷ0QFO"1*
    (FOFSBUPS׆༻ঢ়گ
    w 0QFO"1*υΩϡϝϯτΛ࢖ͬͯࠓޙ΍Γ͍ͨ͜ͱ
    w 4QSJOH
    $MPVE
    $POUSBDU
    0QFO"1*
    w 0QFO"1*
    (FOFSBUPSͷ࠷ۙͷτϐοΫΛ͝঺հ
    w υΩϡϝϯταΠτ͕Ξοϓσʔτ
    w )BOEMFCBSTʹରԠ
    w ΧελϜςϯϓϨʔτΤϯδϯʹରԠ
    w PQFOBQJTUZMFWBMJEBUPSϦϙδτϦ
    w ,VCFSOBUFTͷ3&45
    "1*ΫϥΠΞϯτੜ੒πʔϧͱͯ͠࠾༻͕ਐΜͰ͍Δ
    w ͓ΘΓʹ 0QFO"1*
    (FOFSBUPSʹؔ܎͢Δ
    ׂͱ࠷ۙͷτϐοΫΛ
    େখ͍͔ͭ͘͝঺հ͠·͢
19. υΩϡϝϯταΠτ͕Ξοϓσʔτ IUUQTPQFOBQJHFOFSBUPSUFDI μʔΫϞʔυ αΠτ಺ݕࡧ
20. )BOEMFCBSTʹରԠ FYQFSJNFOUBM w W͔Βɺैདྷͷ.VTUBDIFʹՃ͑ͯɺ)BOEMFCBSTʹࢼݧతʹରԠ
    w F
    FOHJOF ΦϓγϣϯͰςϯϓϨʔτΤϯδϯΛࢦఆ
    w ·ͩ૊ΈࠐΈͷςϯϓϨʔτ͸.VTUBDIFͰॻ͔Ε͍ͯΔ
    w ͳͷͰࠓͷॴɺ)BOEMFCBSTͰςϯϓϨʔτΛॻ͖͍ͨ৔߹͸ɺࣗલͰδΣωϨʔλΫϥε 9YY$PEFHFOΫϥε Λ࣮૷͢Δඞཁ͋Γ
    w δΣωϨʔλΫϥε࣮૷ʹ͍ͭͯͷυΩϡϝϯτ
    w IUUQTPQFOBQJHFOFSBUPSUFDIEPDTDVTUPNJ[BUJPODVTUPNHFOFSBUPSBOEUFNQMBUF $ openapi-generator \ generate \ -e handlebars \ -t {Handlebarsͷه๏Ͱॻ͔ΕͨςϯϓϨʔτ} ɹ {লུ}
21. ΧελϜςϯϓϨʔτΤϯδϯʹରԠ FYQFSJNFOUBM w W͔ΒࢼݧతʹରԠ
    w ྫ
    1FCCMF
    
    &3#
    
    4NBSUZ
    ͰςϯϓϨʔτΛॻ͖͍ͨ৔߹
    w 5FNQMBUF&OHJOF"EBQUFSΠϯλʔϑΣʔεΛ࣮૷͢Δ
    w ΧελϜςϯϓϨʔτΤϯδϯ͍ͭͯͷυΩϡϝϯτ
    w IUUQTPQFOBQJHFOFSBUPSUFDIEPDTUFNQMBUJOHDVTUPNFOHJOFT # PebbleςϯϓϨʔτΤϯδϯʹରԠͨ͠ΞμϓλΛclasspathʹೖΕ࣮ͯߦ͢Δ $ java -cp \ /path/to/pebble-adapter.jar:modules/openapi-generator-cli/target/openapi-generator-cli.jar \ generate \ -e pebble \ -g php \ {লུ}
22. 0QFO"1*5PPMTPQFOBQJTUZMFWBMJEBUPS w 0QFO"1*υΩϡϝϯτͷ-JOUπʔϧ
    w νʔϜ΍ϓϩμΫτಠࣗͷهड़ϧʔϧΛܾΊͯɺݕূΛࣗಈԽͰ͖Δ
    w ྫ
    PQFSBUJPO*E͸ඞͣࢦఆ͢Δɺ.PEFMʹ͸ඞͣFYBNQMFTΛఆٛ͢ΔɺϓϩύςΟ໊͸ΩϟϝϧέʔεͰ $ java \ -jar /path/to/openapi-style-validator-cli.jar \ -s openapi.yaml \ # ର৅ͷOpenAPIυΩϡϝϯτ -o options.json # όϦσʔγϣϯͷϧʔϧΛఆٛͨ͠JSONϑΝΠϧ *ERROR* in Model 'Pet', property 'status', field 'example' -> This field should be present and not empty $ echo $status 1 IUUQTHJUIVCDPN0QFO"1*5PPMTPQFOBQJTUZMFWBMJEBUPS FYBNQMF͕
    ະఆٛʹͳ͍ͬͯΔͷΛ
    ࢦఠͯ͘͠Ε͍ͯΔ
23. ,VCFSOBUFTͷ3&45
    "1*ΫϥΠΞϯτੜ੒πʔϧͱͯ͠࠾༻ w 4XBHHFS
    $PEFHFO͕࢖ΘΕ͍͕ͯͨɺ4XBHHFS
    $PEFHFO ͷ։ൃ͕͋·Γ׆ൃͰ͸ͳ͍ͨΊʹɺੜ੒ޙͷίʔυʹಠࣗ ʹύονΛ౰ͯͯӡ༻͍ͯͯ͠ϝϯςφϯε͕ਏ͍ঢ়ଶͩͬ ͨ
    w ҠߦࡁΈ
    
    w $ɺ)BTLFMMɺ+BWBɺ1FSMɺ1ZUIPOɺ5ZQF4DSJQU
    w Ҡߦத
    
    w (Pɺ3VCZ IUUQTHJUIVCDPNLVCFSOFUFTDMJFOUHFOJTTVFT
24. ͓ΘΓʹ
25. ׆ൃͳ։ൃίϛϡχςΟ IUUQTTUBSTQS[FNFLOPXBLDPN (PPHMFτϨϯυ TXBHHFSDPEFHFO PQFOBQJHFOFSBUPS (JU)VCελʔ IUUQTXXXTMJEFTIBSFOFUUFDICMPHZBIPPTXBHHFSPQFOBQJTQFDJpDBUJPOBQJ 4XBHHFS
    Ͱ͸ͳ͍
    0QFO"1*
    4QFDJpDBUJPO
    
    ʹΑΔ
    "1*
    αʔόʔ։ൃ IUUQTPQFOBQJHFOFSBUPSUFDIVTFST ϢʔβʔاۀϓϩδΣΫτ IUUQTHJUIVCDPN0QFO"1*5PPMTPQFOBQJHFOFSBUPS ϒϩάهࣄɺൃදεϥΠυ
26. ҰํͰʜɺ w ͨͱ͑ίΞνʔϜͷϝϯόʔͰ΋ɺશ͘஌Βͳ͍ݴޠͷϝϯςφϯε͸ݫ͍͠ʜ
    w 0QFO"1*
    (FOFSBUPS͕αϙʔτ͍ͯ͠Δݴޠ͸Ҏ্ ʢ
    ଺ཹͯ͠͠·͏JTTVF
    
    ʣ w ʮ0QFO"1*
    (FOFSBUPS͸ίί͕Πέͯͳ͍ΜͩΑͳ͊ʯ
    w ʮͪΐͬͱ044ͷ։ൃ΍ͬͯΈ͍ͨͳʯ
    w ʮϓϧϦΫग़͢ͷ͸ϋʔυϧߴ͍ͳ͊ɺ͍ͯ͏͔ӳޠͩ͠ʜʯ ؾܰʹ͓੠ֻ͚͍ͩ͘͞ʂαϙʔτ͠·͢
    ✨
27. ࢲͨͪͱҰॹʹ։ൃ͠·ͤΜ͔