Web API に秩序を与える Protocol Buffers / Protocol Buffers for Web API #builderscon

by Nao Minami

Slide 1

Slide 1 text

Slide 2

Slide 2 text

Slide 3

Slide 3 text

Slide 4

Slide 4 text

Slide 5

Slide 5 text

Slide 6

Slide 6 text

Slide 7

Slide 7 text

Slide 8

Slide 8 text

Slide 9

Slide 9 text

Slide 10

Slide 10 text

Slide 11

Slide 11 text

Slide 12

Slide 12 text

©2019 Wantedly, Inc. (PPHMF੡ͷ4FSJBMJ[BUJPO-JCSBSZ *OUFSGBDF%FpOJUJPO-BOHVBHF *%- w *%-Ͱ"1*4DIFNBΛهड़͠ɺTFSJBMJ[BUJPOEFTFSJBMJ[BUJPOίʔυ Λࣗಈੜ੒ w *%-Ͱهड़ͨ͠಺༰ʢQSPUPpMFʣ͸ɺ"1*ʹର͢Δ੩తܕ෇͚ͱͳΔ w 1SPUPDPM#V⒎FSTίϯύΠϥʢQSPUPDʣ͸QMVHJOͰ༷ʑͳػೳ֦ு ͕Մೳ w TXBHHFSKTPOͷੜ੒ H31$ར༻ FUD w ༷ʑͳݴޠͰར༻Մೳ w $$ (P +BWB 1ZUIPO 3VCZ /PEF FUD 1SPUPDPM#VGGFSTͱ͸ʁ

Slide 13

Slide 13 text

Slide 14

Slide 14 text

©2019 Wantedly, Inc. service BookService { rpc getBook (getBookRequest) returns (Book) { option (google.api.http) = { get: "/api/books/{id}" }; } } message getBookRequest { int64 id = 1; } message Book { int64 id = 1; string title = 2; } #PPL"1*ͷ4DIFNBΛQSPUPGJMFʹهड़

Slide 15

Slide 15 text

©2019 Wantedly, Inc. QSPUPDͰίʔυࣗಈੜ੒ w ͦΕͧΕͷNFTTBHFΛTFSJBMJ[FEFTFSJBMJ[F͢ΔSVOUJNFMJCSBSZ ͷίʔυΛࣗಈੜ੒ ྫQSPUPGJMF͔Βίʔυࣗಈੜ੒ Google::Protobuf::DescriptorPool.xxx do add_message "books.GetBookRequest" do optional :id, :int64, 1 end add_message "books.Book" do optional :id, :int64, 1 optional :title, :string, 2 end end module Books GetBookRequest = XXX(“books.GetBookRequest”).msgclass Book = XXX(“books.Book").msgclass end message getBookRequest { int64 id = 1; } message Book { int64 id = 1; string title = 2; } QSPUPpMF 3VCZ

Slide 16

Slide 16 text

©2019 Wantedly, Inc. [1] book = Book.new(id: 2, title: "Hello, Book") => [2] book.to_proto => "\b\x02\x12\vHello, Book” [3] book.to_json => "{\"id\":2,\"title\":\"Hello, Book\”}" [4] Book.decode("\b\x02\x12\vHello, Book") => 3VCZ message Book { int64 id = 1; string title = 2; } QSPUPpMF

Slide 17

Slide 17 text

Slide 18

Slide 18 text

©2019 Wantedly, Inc. service BookService { rpc getBook (getBookRequest) returns (Book) { option (google.api.http) = { get: "/api/books/{id}" }; } } TXBHHFSQMVHJOͰ+40/Λࣗಈੜ੒ w HSQDHBUFXBZQSPUPDHFOTXBHHFSQMVHJOΛར༻ w ҎԼͷQSPUPpMFͷ಺༰Λ൓өͨ͠TXBHHFSKTPOΛੜ੒ ྫQSPUPGJMF͔ΒTXBHHFSKTPOΛࣗಈੜ੒

Slide 19

Slide 19 text

©2019 Wantedly, Inc. { "swagger": “2.0", …, "paths": { "/api/books/{id}": { "get": { "operationId": "GetBook", "responses": { "200": { "description": … "schema": { "$ref": "#/definitions/booksBook" } } }, “parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "int64" } ], "tags": … } } }, "definitions": { "booksBook": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "title": { "type": "string" } } } } }

Slide 20

Slide 20 text

Slide 21

Slide 21 text

Slide 22

Slide 22 text

Slide 23

Slide 23 text

©2019 Wantedly, Inc. ͳͥ1SPUPDPM#VGGFSTΛར༻͢Δͷ͔ʁ ࣗಈੜ੒ίʔυར༻ʹΑΔ"1* 4DIFNBͷอূ w QSPUPpMFΛਖ਼֬ʹ൓өͨ͠4FSJBMJ[FS%FTFSJBMJ[FSΛར༻͢ΔͷͰ ʮ࣮૷ͱ4DIFNBͷڍಈ͕ͣΕΔʯͱ͍͏ࣄ͕ݪཧతʹൃੜ͠ͳ͍ w 4XBHHFSͷ༷ʹUFTU΍WBMJEBUJPOͰ୲อ͢ΔͷͰ͸ͳ͘ɺͨͩ QSPUPD͕ੜ੒͢ΔίʔυΛར༻͢Ε͹ྑ͍ ʮੜ͖ͯΔυΩϡϝϯτʯΛ؆୯͔࣮ͭ֬ʹ࡞Δ͜ͱ͕Ͱ͖Δ

Slide 24

Slide 24 text

©2019 Wantedly, Inc. 4FSJBMJ[FS%FTFSJBJM[FSͷػೳ w pFMEͷ௥Ճ΍ϦωʔϜ͸ޙํޓ׵ੑΛյ͞ͳ͍ w ݹ͍QSPUPpMF͔Βੜ੒ͨ͠%FTFSJBMJ[FSͰ΋৽͍͠ CJOBSZΛ%FTFSJBMJ[FͰ͖Δɻͦͷٯ΋વΓɻ ෳ਺ϚΠΫϩαʔϏεͷಉ࣌EFQMPZͳͲΛۃྗݮΒͤΔ w CJOBSZGPSNBU͸+40/ΑΓ΋TFSJBMJ[FEFTFSJBMJ[F͕ૣ͘ɺ EBUBTJ[F΋খ͍͞ 4FSJBMJ[FS%FTFSJBMJ[FSͷػೳ͕༏Ε͍ͯΔ ͳͥ1SPUPDPM#VGGFSTΛར༻͢Δͷ͔ʁ

Slide 25

Slide 25 text

©2019 Wantedly, Inc. ͳͥ1SPUPDPM#VGGFSTΛར༻͢Δͷ͔ʁ QSPUPDͷ๛෋ͳQMVHJO w QMVHJOʹΑ༷ͬͯʑͳػೳ֦ு͕Մೳ w FHTXBHHFSKTPOͷੜ੒ w FHQSPUPpMFͷ಺༰Λ+40/ܗࣜ΁ม׵ w FHH31$ HSQDHBUFXBZͷར༻ w ಛʹɺTXBHHFSKTPO͸ݩʑ8FC'SPOUFOE .PCJMF"QQνʔϜͱͷ ίϛϡχέʔγϣϯʹར༻͍ͯͨ͠ͷͰɺԸܙ͕େ͖͔ͬͨ w QSPUPDQMVHJOΤίγεςϜ͕࡞ΒΕ͖͍ͯͯΔ

Slide 26

Slide 26 text

Slide 27

Slide 27 text

Slide 28

Slide 28 text

Slide 29

Slide 29 text

Slide 30

Slide 30 text

Slide 31

Slide 31 text

Slide 32

Slide 32 text

Slide 33

Slide 33 text

Slide 34

Slide 34 text

©2019 Wantedly, Inc. HSBQJΛར༻ͯ͠ɺ1SPUPDPM#VGGFST ͷϝϦοτΛڗड w QSPUPpMFΛॻ͘ͱɺH31$HSQDHBUFXBZͷίʔυΛࣗಈੜ੒ 4DIFNBΛݫີʹຬͨ͢"1*TFSWFSΛ؆୯ʹ࡞੒Մೳ w QSPUPDQMVHJOͰTXBHHFSKTPOΛੜ੒ 4XBHHFS6*ͳͲɺ4XBHHFSΤίγεςϜΛ׆͔ͤΔ w ৄࡉ͸ҎԼͷϦϯΫΛࢀর (PΛར༻ͨ͠ϚΠΫϩαʔϏε։ൃ IUUQTTQFBLFSEFDLDPNJ[VNJOHSBQJCVMEJOHKTPOBQJ TFSWFSXJUIHSQDHBUFXBZGPSNJDSPTFSWJDFT

Slide 35

Slide 35 text

Slide 36

Slide 36 text

Slide 37

Slide 37 text

©2019 Wantedly, Inc. > PATCH /api/books/2 HTTP/1.1 > Accept: application/protobuf > Content-Type: application/protobuf > > \x08\x02 < HTTP/1.1 200 OK < Content-Type: application/protobuf < < \x08\x02\x12\x0BHello, Book [1] book = Book.new(id: 2, title: "Hello, Book") => [2] book.to_proto => "\b\x02\x12\vHello, Book” 3VCZ )551SFRVFTUSFTQPOTF

Slide 38

Slide 38 text

©2019 Wantedly, Inc. Mime::Type.register "application/protobuf", :protobuf ActionController::Renderers.add :protobuf do |obj, _| send_data obj.to_proto, type: Mime[:protobuf] end 3VCZPO3BJMTJOJUJBMJ[FS def show req = GetBookRequest.decode(request.body.read) … book = Book.new(id: xxx, title: yyy) render protobuf: book end 3VCZPO3BJMTDPOUSPMMFS

Slide 39

Slide 39 text

Slide 40

Slide 40 text

Slide 41

Slide 41 text

©2019 Wantedly, Inc. #BDLFOE'PS'SPOUFOE #'' ͱͳΔ 5ZQF4DSJQUαʔόʔ͕ଘࡏ w #SPXTFSͱ͸(SBQI2-Ͱ௨৴͠ɺ#BDLFOE4FSWFSͱͷ௨৴ʹ͸ 1SPUPDPM#V⒎FSTΛར༻ 5ZQF4DSJQU͔Βͷ1SPUPDPM#VGGFSTར༻ #SPXTFS .PCJMF"QQ 5ZQF4DSJQU (SBQI2- 1SPUPDPM#V⒎FST

Slide 42

Slide 42 text

Slide 43

Slide 43 text

Slide 44

Slide 44 text

Slide 45

Slide 45 text

Slide 46

Slide 46 text

Slide 47

Slide 47 text

Slide 48

Slide 48 text

©2019 Wantedly, Inc. (PPHMFͷ"1*%FTJHO(VJEFͷଘࡏ w (PPHMF$MPVE"1*TͳͲ(PPHMFͷެ։"1*͸QSPUPpMFͰهड़ ͞Ε͓ͯΓɺͦΕ͕४ڌ͢Δ"1*%FTJHO(VJEF΋ެ։͞Ε͍ͯΔɹ w DGIUUQTHJUIVCDPNHPPHMFBQJTHPPHMFBQJT w DGIUUQTDMPVEHPPHMFDPNBQJTEFTJHO w (PPHMF"1*T͸༏Ε࣮ͨྫͱͳ͍ͬͯΔ w "1*%FTJHO(VJEF͸"1*ઃܭͷࢀߟʹͰ͖Δ w ඪ४తͳܕͳͲ΋(PPHMFʹΑͬͯଟ਺ఆٛ͞Ε͍ͯͯར༻Ͱ͖Δ 1SPUPDPM#VGGFSTΛར༻ͯ͠ײͨ͡ϝϦοτ

Slide 49

Slide 49 text

©2019 Wantedly, Inc. ੩తಈతݴޠ྆ํ͔Βѻ͍΍͍͢ w QSPUPpMF͸"1*ʹର͢Δ੩తܕ෇͚ͱͯ͠ػೳ͢Δ w (Pͷ༷ͳ੩తܕ෇͚ݴޠ͔Β΋ѻ͍΍͍͢ɻQBZMPBEΛ੩తܕ෇͚ ͞ΕͨTUSVDU΁NBSTIBMVONBSTIBMͰ͖Δɻ w 3VCZͷ༷ͳಈతܕ෇͚ݴޠͰ΋ѻ͍΍͍͢ɻpFME໊ͷUZQPͳͲΛ ߟ͑ͳͯ͘ྑ͍ɻ 1SPUPDPM#VGGFSTΛར༻ͯ͠ײͨ͡ϝϦοτ

Slide 50

Slide 50 text

Slide 51

Slide 51 text

Slide 52

Slide 52 text

Slide 53

Slide 53 text

©2019 Wantedly, Inc. 1SPUPDPM#VGGFSTΛར༻͢ΔதͰݟ͖͑ͯͨ஫ҙ఺ QSPUPpMFͷڞ༗ํ๏͸੔උ͕ඞཁ w 1SPUPDPM#V⒎FST͸$MJFOU 4FSWFS྆ํ͕ಉ͡QSPUPpMFΛࢀর͢Δ ඞཁ͕͋Δɻ 3FQPTJUPSZ͕෼͔Ε͍ͯΔ৔߹ɺQSPUPpMFͷڞ༗͕ඞཁ w ڞ༗ํ๏͝ͱͷϝϦοτɾσϝϦοτΛߟ͑Δඞཁ͕͋Δ w ୯७ͳίϐʔʜ࣮ݱ͕؆୯͕ͩɺQSPUPpMFͷมߋ௥ै͕೉͍͠ w QSPUPEFQ౳ͷπʔϧʜ$MJFOU͔ΒWFSTJPOࢦఆ͕Մೳ w QSPUPpMFू໿SFQPTJUPSZʜSFQPTJUPSZʹQSPUPpMFΛू໿ɻ ίʔυੜ੒ͯ͠MJCSBSZͱͯ͠഑৴ɻEFQFOEBCPUͰมߋΛ௨஌ɻ w 8BOUFEMZͰ͸ϓϩδΣΫτ͝ͱʹόϥόϥ͕ͩɺQSPUPpMFू໿ SFQPTJUPSZͷར༻͕૿Ճத

Slide 54

Slide 54 text

©2019 Wantedly, Inc. 1SPUPDPM#VGGFSTΛར༻͢ΔதͰݟ͖͑ͯͨ஫ҙ఺ 1SPUPDPM#VGGFSTίϯύΠϥ QSPUPD ͷWFSTJPOʹ஫ҙ͢Δ w QSPUPDWFSTJPOͷҧ͍ʹΑͬͯɺࣗಈੜ੒ͨ͠ίʔυ಺༰͕มΘΔ w ޓ׵ੑ͸΄ͱΜͲյΕͳ͍͸͕ͣͩɺಛʹ(PͰݟͨ໨ͷEJ⒎͕ େ͖͘WFSTJPOΛ্͛ͮΒ͔ͬͨ w ։ൃऀͦΕͧΕ͕QSPUPDͰίʔυੜ੒͢Δ৔߹ɺQSPUPDWFSTJPO Λἧ͑Δඞཁ͋Γ VCFSQSPUPUPPMͳͲΛར༻ͯ͠WFSTJPOΛݻఆ͢Δͱྑ͍

Slide 55

Slide 55 text

Slide 56

Slide 56 text

©2019 Wantedly, Inc. 1SPUPDPM#VGGFSTΛར༻͢ΔதͰݟ͖͑ͯͨ஫ҙ఺ ݴޠʹΑͬͯ͸4FSJBMJ[BUJPO-JCSBSZ ͷػೳ͕ශऑ w +BWB4DSJQUpFMEͷTFU͸TFUUFSNFUIPEΛར༻͢Δඞཁ͕͋Δ w FHTFU*E TFU/BNF FUD w 3VCZSFQFBUFEpFME͸"SSBZMJLF͕ͩඍົʹ࢖͍উख͕ҧ͏ w ୯७ͳTFU͸ग़དྷͣɺSFQMBDF͕ඞཁ w "DUJWF3FDPSEͷXIFSFʹͦͷ··౉ͤͳ͍

Slide 57

Slide 57 text

©2019 Wantedly, Inc. [1] book = Book.new(id: 1) => [2] book.authors => [] [3] book.authors.class => Google::Protobuf::RepeatedField [4] book.authors = [Author.new(id: 2)] Google::Protobuf::TypeError: Expected repeated field array from (pry):4:in `method_missing’ [5] book.authors.replace([Author.new(id: 2)]) => [] [6] book.authors => []

Slide 58

Slide 58 text

©2019 Wantedly, Inc. [1] req = ListBookRequest.new(ids: [1, 2, 3]) => [2] req.ids.class => Google::Protobuf::RepeatedField [4] Book.where(id: req.ids).to_sql => "SELECT \"books\".* FROM \"books\" WHERE \"books\".\"id\" = NULL" [3] Book.where(id: req.ids.to_a).to_sql => "SELECT \"books\".* FROM \"books\" WHERE \"books\".\"id\" IN (1, 2, 3)"

Slide 59

Slide 59 text

©2019 Wantedly, Inc. 1SPUPDPM#VGGFSTΛར༻͢ΔதͰݟ͖͑ͯͨ஫ҙ఺ 1SPUPDPM#VGGFST8FMMLOPXO5ZQFT ͷѻ͍͸গ͠໘౗ w 1SPUPDPM#V⒎FST্Ͱ࣌ؒΛදݱ͢ΔHPPHMFQSPUPCVG5JNFTUBNQ w ݴޠ͝ͱͷ5JNF࣮૷ͱ͸ผͳͷͰຖճXSBQVOXSBQ͢Δඞཁ͋Γ w 4USJOH7BMVF *OU7BMVFͳͲͷOVMMBCMFUZQFT w TUSJOH JOUͳͲΛOVMMBCMFʹ͢Δҝʹར༻ w ͜Ε΋XSBQVOXSBQͷख͕͔͔ؒΔ

Slide 60

Slide 60 text

©2019 Wantedly, Inc. 1SPUPDPM#VGGFSTΛར༻͢ΔதͰݟ͖͑ͯͨ஫ҙ఺ CJOBSZGPSNBUͷՄࢹԽํ๏Λߟ͑Δ ඞཁ͋Γ w MPHʹ࢒͢ࡍͳͲɺCJOBSZGPSNBUͷ··Ͱ͸ղऍͮ͠Β͍ ྫ͑͹MPHΛར༻͢ΔλΠϛϯάͰ%FTFSJBMJ[F͢Δ w SFRVFTUSFTQPOTFͷ಺༰֬ೝʹ͸ɺՄࢹԽ͕ඞཁ +40/ͱ1SPUPDPM#V⒎FST྆ํΛฦ͢αʔόʔͱͯ͠։ൃ

Slide 61

Slide 61 text

©2019 Wantedly, Inc. 1SPUPDPM#VGGFSTΛར༻͢ΔதͰݟ͖͑ͯͨ஫ҙ఺ H31$HSQDHBUFXBZߏ੒ͷ࣌ มߋʹΑͬͯ͸ޙํޓ׵ੑ͕յΕΔ w QSPUPpMFͷFOVN஋Λ૿΍ͨ͠ࣄʹΑͬͯɺSFRVFTUQBSBNFUFS Ͱ͋Δ+40/ͷ%FTFSJBMJ[FͰFSSPS͕ى͖ͨέʔε͕͋ͬͨ w H31$HSQDHBUFXBZߏ੒ͷ࣌͸ɺ҆શͳมߋ͔ෆ҆ͳ࣌͸ڍಈΛ ֬ೝͨ͠΄͏͕ྑ͍

Slide 62

Slide 62 text

Slide 63

Slide 63 text

Slide 64

Slide 64 text

©2019 Wantedly, Inc. ·ͱΊ 1SPUPDPM#VGGFSTΛ"1*ͷ4DIFNB ؅ཧʹར༻͢Δͱଟ͘ͷར఺͕͋Δ w QSPUPpMFͱͯ͠"1*ͷৼΔ෣͍Λએݴతʹهड़ w ࣗಈੜ੒ͨ͠ίʔυʹΑͬͯ4DIFNBͱ࣮૷ͷҰகΛอূ w ੩తಈతܕ෇͚ݴޠ྆ํ͔Βѻ͍΍͍͢ w TXBHHFSKTPOͷੜ੒ͳͲɺQSPUPDQMVHJOͷΤίγεςϜΛ׆༻Մೳ ϝϦοτΛڗड͠ੜ࢈ੑߴ͘։ൃ͠Α͏ʂ

Slide 65

Slide 65 text

©2019 Wantedly, Inc. "QQEFOEJYH31$ʹ͍ͭͯ H31$΋ݱࡏݕূத w LTDMVTUFS಺ͷϚΠΫϩαʔϏεʹରͯ͠FOWPZ͕TJEFDBSQSPYZ ͱͯ͠EFQMPZ͞ΕΔ༷ʹͳͬͨ )551MPBECBMBODJOH͕Մೳʹͳͬͨ w HSQDHBUFXBZΛ௨ͣ͞ʹ(PͷH31$αʔόʔͱ௨৴ͨ͠Γɺ৽͍͠ 3VCZαʔόʔΛH31$αʔόʔͱͯ͠։ൃ͢ΔࢼΈΛ͍ͯ͠Δ 1SPUPDPM#V⒎FSTͷԸܙΛड͚ͭͭɺUSBOTQPSU΋ޮ཰Խ

Slide 66

Slide 66 text