速習XRPC / Learning XRPC

Bluesky/ATProtocol勉強会 #1の発表資料です。
Bluesky (ATP) のAPIを叩いてみたい人向けに、基本的な概念や触り方を解説しています。

Transcript

1. ଎श931$ #MVFTLZ"51SPUPDPMษڧձ
    ח૔
   !PNJCTLZTPDJBM
2. ࣗݾ঺հ w 8FCΤϯδχΞ
   w ੨Ӣͱ͍͏#MVFTLZ༻"OESPJEΫϥΠΞϯτΛ࡞ͬͯ·͢
   w IUUQTHJUIVCDPNBLJPNJLTFJVO
3. લఏ஌ࣝͱΰʔϧ w લఏ஌ࣝ
   w Ұൠతͳ8FC"1*͕৮ΕΔ
   w ˞
   ࣮૷ऀࢹ఺ͷ࿩͕த৺Ͱ͢
   w ΰʔϧ
   w -FYJDPOͷجຊతͳา͖ํ͕Θ͔Δ
   w ཁ఺Λ͔͍ͭ·ΜͰۦ͚଍ؾຯʹਐΈ·͢
4. ΞδΣϯμ w ओཁͳͭͷ༻ޠ
   931$ɺ-FYJDPOɺ/4*%
   w -FYJDPOೖ໳
   ୳͠ํͱओཁͳܕ
   w ϦΫΤετͱೝূ
   w SFDPSEͱϦϙδτϦͷૢ࡞
   w ͦͷଞ
5. ओཁͳͭͷ༻ޠ
6. 931$ w $SPTTTZTUFN
   3FNPUF
   1SPDFEVSF
   $BMMT
   w 31$
   ԕִखଓ͖ݺͼग़͠
   ͷن֨ͷҰछ
   w H31$
   40"1
   
   w "51SPUPDPMͷಠࣗ࢓༷
   w )551 4
   ͷ্Ͱಈ࡞
   w 1%4ͱͷσʔλͷ΍ΓऔΓʹར༻
7. -FYJDPO w ϨΩγίϯ
   w ӳ
   <໊>
   ༻ޠूɺޠኮɺࣙॻ
   w 931$ͷϝιου΍σʔλܕͷఆ ٛ
   w ·ͨ͸ͦΕΒͷϑΥʔϚοτ
   +40/
   4DIFNB෩
8. /4*% w /BNF4QBDFE
   *%
   w -FYJDPOͷϦιʔεΛҰҙʹࣝผ͢ ΔͨΊͷ*%
   w 3FWFSTF%/4ܗࣜͰදه
   w +BWBͰΑ͘ݟΔΞϨ
   w ΤϯυϙΠϯτ·ͨ͸ܕͱͯ͠࢖༻
9. "51SPUPDPM
   931$
   Ͱͷ"1*ݺͼग़͠
   
   -FYJDPOʹΑͬͯݺͼग़͕͠ఆΊΒΕͨ
   /4*%ܗࣜͷΤϯυϙΠϯτΛίʔϧ
10. -FYJDPOࣄ࢝Ί
11. -FYJDPOͷ୳͠ํ w ެࣜυΩϡϝϯτʹҰཡ͋Γ·͢
    w IUUQTBUQSPUPDPNEPDT
    w ͨͩ͠৘ใ͕ݹ͔ͬͨΓ΍ෆ଍͍ͯ͠ Δ৔߹΋
    w ࠷৽ͷ࢓༷ʹ͍ͭͯ͸HJUIVCͷϦϙδτ Ϧͷ
    MFYJDPOT
    Λࢀর͢Δͷ͕࣮֬
    w IUUQTHJUIVCDPNCMVFTLZTPDJBM BUQSPUPUSFFNBJOMFYJDPOT
12. -FYJDPOͷܕ w PCKFDU
    w QSPDFEVSF
    w RVFSZ
    w ϓϦϛςΟϒܕ
    JOUFHFS΍TUSJOHͳͲ
    w ಛघͳܕ
    SFDPSE
    SFG
    VOJPO
    CMPC
    UPLFO
    TVCTDSJQUJPOͳͲ
    w ࠓճ͸SFDPSEͷΈѻ͍·͢
13. PCKFDU { "id": "app.bsky.actor.defs", "defs": { "profileViewBasic": { "type": "object", "required": ["did", "handle"], "properties": { "did": { "type": "string" }, "handle": { "type": "string" }, "avatar": { "type": "string" }, "viewer": { "type": "ref" }, "labels": { "type": "array" } } } } } w Ұൠతͳσʔλܕ
    w SFRVJSFE͸OPU
    OVMM
    w ˠͷ/4*%͸ BQQCTLZBDUPSEFGTQSP fi MF7JFX#BTJD ˞ൈਮ
14. QSPDFEVSF { "id": "com.atproto.server.createSession", "defs": { "main": { "type": "procedure", "input": { "schema": { "properties": { "identifier": { "type": "string" }, "password": { "type": "string" } } } }, "output": { "schema": { "properties": { "accessJwt": { "type": "string" }, "did": { "type": "string" }, } } } } } } w ߋ৽ܥϝιου
    w JOQVUPVUQVUΛ࣋ͭ
    w ӈͷ/4*%͸ DPNBUQSPUPTFSWFSDSFB UF4FTTJPO
    NBJO͸লུ ˞ൈਮ
15. RVFSZ { "id": "app.bsky.feed.getTimeline", "defs": { "main": { "type": "query", "parameters": { "type": "params", "properties": { "cursor": { "type": "string" } } }, "output": { "schema": { "properties": { "cursor": { "type": "string" }, "feed": { "type": "array" } } } } } } } w ࢀরܥϝιου
    w QBSBNFUFSTPVUQVUΛ࣋ͭ
    w ˠͷ/4*%͸ BQQCTLZGFFEHFU5JNFMJO F ˞ൈਮ
16. ϦΫΤετͱೝূ
17. ϦΫΤετ w #MVFTLZ
    ͷ৔߹͸
    IUUQTCTLZTPDJBMYSQDOJTE
    ʹରͯ͠ߦ͏
    w αʔυύʔςΟ1%4ͷ৔߹͸
    ACTLZTPDJBMA
    ͷ෦෼͕มΘΔ
    w ྫ
    w QSPDFEVSF
    1045
    IUUQTCTLZTPDJBMYSQD DPNBUQSPUPTFSWFSDSFBUF4FTTJPO
    w RVFSZ
    (&5
    IUUQTCTLZTPDJBMYSQDBQQCTLZGFFEHFU5JNFMJOF
18. ϩάΠϯͷ-FYJDPO { "id": "com.atproto.server.createSession", "defs": { "main": { "type": "procedure", "input": { "encoding": "application/json", "schema": { "required": [ "identifier", "password" ], "properties": { "identifier": { "type": "string" }, "password": { "type": "string" } } } } } } } ˞ൈਮ ϦΫΤετ͸1045 ϦΫΤετ#PEZ͸+40/ JEFOUJ fi FSͱQBTTXPSE͸ඞਢ
    IBOEMF
    PS
    FNBJM ΤϯυϙΠϯτ͸
    
    YSQDDPNBUQSPUPTFSWFSDSFBUF4FTTJPO
19. ϩάΠϯͷϦΫΤετ curl -X POST \ -H 'Content-Type: application/json' \ -d '{"identifier": "tester.bsky.social", "password": "foo"}' \ 'https://bsky.social/xrpc/com.atproto.server.createSession' # response { "did":"did:plc:ji4f2ypncqko5cm62pmyxh67", ... "accessJwt":"...", "refreshJwt":"..." } ೝূ͕ඞཁͳΤϯυϙΠϯτ͸
    ฦ͖ͬͯͨ+85ΛϦΫΤετʹؚΊΔ
20. RVFSZͷ-FYJDPO
    ϢʔβϑΟʔυͷऔಘ { "id": "app.bsky.feed.getAuthorFeed", "defs": { "main": { "type": "query", "parameters": { "type": "params", "required": ["actor"], "properties": { "cursor": { "type": "string" } } } } } } ˞ൈਮ ϦΫΤετ͸(&5 ΫΤϦύϥϝʔλ ΤϯυϙΠϯτ͸
    YSQDBQQCTLZGFFEHFU"VUIPS'FFE BDUPS
    ͲͷϢʔβ͔
    ͸ඞਢ
21. RVFSZͷϦΫΤετ
    ϢʔβϑΟʔυͷऔಘ curl -X GET -H 'Authorization: Bearer ${createSessionで取得したaccessJwt}' 'https://bsky.social/xrpc/app.bsky.feed.getAuthorFeed?actor=foo'
22. ϦϙδτϦͱSFDPSE
23. ϦϙδτϦ
    %BUB
    3FQPTJUPSZ w 5-%3
    w ϦϙδτϦ͸ॺ໊σʔλͷίϨΫγϣϯ
    w HJUͷϦϙδτϦΈ͍ͨͳ΋ͷ
    ͨͩ͠%#ͷϨίʔυ༻
    w Ϣʔβ͸֤ʑͷެ։ΞΫςΟϏςΟΛࣗ෼ͷϦϙδτϦʹ௥ه
    w #MVFTLZ
    BQQCTLZ
    ͷ৔߹ɺ౤ߘɾϑΥϩʔɾ͍͍ͶͳͲ͕֨ೲ͞ ΕΔ
24. SFDPSE { "id": "app.bsky.feed.post", "defs": { "main": { "type": "record", "key": "tid", "record": { "type": "object", "required": ["text", "createdAt"], "properties": { "text": { "type": "string" }, "createdAt": { "type": "string", "format": "datetime" } } } } } } w
    
    ϦϙδτϦ༻ͷσʔλܕ
    w ˠ͸#MVFTLZͷ౤ߘ
    QPTU
    ͷܕ ˞ൈਮ
25. ϦϙδτϦૢ࡞ { "id": "com.atproto.repo.createRecord", "defs": { "main": { "type": "procedure", "input": { "encoding": "application/json", "schema": { "type": "object", "properties": { "repo": { "type": "string" }, "collection": { "type": "string" }, "record": { "type": "unknown" } } } } } } } w ϦϙδτϦ΁ͷϨίʔυ ௥ՃͷQSPDFEVSF
    w ౤ߘ΍ϑΥϩʔͳͲ͸ର ৅ͱͳΔSFDPSEΛ౉ͯ͠ ߦ͏ ˞ൈਮ
26. ౤ߘ࡞੒ͷϦΫΤετ curl -X POST \ -H 'Authorization: Bearer ${accessJwt}' \ -H 'Content-Type: application/json' \ -d '{ "repo": "tester.bsky.social", "collection": "app.bsky.feed.post", "record": { "text": "Hello, world!", "createdAt": "2023-04-28T22:00:00+09:00" } }' \ 'https://bsky.social/xrpc/com.atproto.repo.createRecord'
27. ͦͷଞࡉ͔͍৭ʑ w SLFZ͸
    BUBMJDFIPTUDPNJPFYBNQMFTPOHZ*D[DDQB
    ͷ
    Z*D[DDQB
    w CMPCͷܕ͸͜ͷลΛࢀর
    w େഁյҎલͷσʔλ͸SFGͱTJ[F͕ͳ͍ͷͰ஫ҙ
    w !BUQSPUPBQJͩͱࣗಈͰSFGͱTJ[FΛิ׬͢ΔΑ͏ʹͳ͍ͬͯΔ
    w ΤϥʔϋϯυϦϯά͸͜͜Λࢀর
28. ิ଍ͱ͔ w ۦ͚଍Ͱ͢Έ·ͤΜʂ
    w ʮࠓ೔ͷൃදͳΜ΋Θ͔ΒΜ͔ͬͨʯͱ͍͏ํ͸NBUUO͞Μͷʰ։ൃ ࢹ఺͔ΒݟΔɺ৽͍͠෼ࢄܕ4/4ʮ#MVFTLZʯͱ"5
    1SPUPDPMͷՄೳ ੑʱͱ͍͏هࣄ΋νΣοΫͯ͠Έ͍ͯͩ͘͞
    w IUUQTHJIZPKQBSUJDMFCMVFTLZBUQSPUPDPM
29. Ҏ্🫡