5分くらいでわかるSwagger / 5minutes-swagger

Transcript

1. Swagger 5෼͘Β͍ͰΘ͔Δ T. Endo
2. http://swagger.io/
3. 4XBHHFS w 3&45GVM
   "1*υΩϡϝϯτ࡞੒ͷͨΊ ͷϑϨʔϜϫʔΫ
   w +40/
   PS
   :".-
   Ͱ"1*࢓༷Λॻ͘ ʢ4XBHHFS
   4QFDJpDBUJPOɺҎԼɺ4XBHHFS
   4QFDʣ w 0QFO
   "1*
   *OJUJBUJWFͰ࠾༻
4. 4XBHHFS
   4QFD
   +40/:".- ίʔυ
   +BWB
   1)1౳ʣ ! 4XBHHFS
   6* "84
   "1*
   (BUFXBZ ֎෦࿈ܞ 4XBHHFS
   $PEFHFO ಡΈࠐΈ "NB[PO
   "1*
   (BUFXBZ
   *NQPSUFS ΤίγεςϜ 4XBHHFS
   &EJUPS
   ʢΦϯϥΠϯΤσΟλʣ
5. 4XBHHFS
   4QFDΛॻ͘ w 4XBHHFS
   &EJUPS
   IUUQFEJUPSTXBHHFSJP ɾΦϯϥΠϯΤσΟλ
   ʢ࢖͍׳ΕͨΤσΟλͰॻ͍ͯ΋Մʣ ɾ݁ߏϝϞϦΛ࢖͏
   ɹ$ISPNF͕ϝϞϦෆ଍Ͱ
   ɹམͪΔ͜ͱ΋ʜ ϦΞϧλΠϜʹ൓ө ɾهड़ͨ͠಺༰͸ίʔυ 4%, ΍
   ɹ4XBHHFS
   4QFD΁ͷ
   ɹΤΫεϙʔτ͕Ͱ͖Δ
6. 4XBHHFS
   6* ͜ͷϑΥʔϜ͔
   zVSMzΫΤϦύϥϝʔλʹ
   TXBHHFS
   TQFD΁ͷ63-Λ
   ॻ͘ ॻ͍ͨ4XBHHFS
   4QFD͕
   
   ʮ7"-*%ʯͰ͋Δ͜ͱΛ
   ֬ೝ
7. ʮ5SZ
   JU
   PVUʯ
   ௚઀"1*Λ࣮ߦͯ͠
   ࢼ͢͜ͱ͕Ͱ͖Δ
   ʢΫϩεΦϦδϯʣ
8. 4XBHHFS
   4QFDͷ
   จ๏
9. 4XBHHFS
   4QFDͷֶͼํ w IUUQTXBHHFSJPTQFDJpDBUJPO
   w ݱόʔδϣϯ͸
   w طଘͷαϯϓϧΛݟ֮ͯ͑Δͷ͕ۙಓ
   ! w ֶशίετ͸௿͍ʢͱࢥ͏ʣ ʢ"NB[PO
   "1*
   (BUFXBZ
   *NQPSUFSͷ
   UTUSFTPVSDFTTXBHHFSҎԼͷϑΝΠϧͱ͔͓͢͢Ίʣ
10. 4XBHHFS
    4QFDͷߏ଄ جຊ৘ใ swagger ! info! host! schemes! basePath! tags! produces "1*ఆٛ Ϟσϧఆٛ paths definitions \ \ \ ˞
    ඞਢ߲໨ ʢ஫ʣ͜ΕͰશͯͰ͸ͳ͍Ͱ͢
11. جຊ৘ใ swagger: '2.0'! info:! title: Sample API! description: Swagger Sample! host: xxx.sample.jp! schemes:! - https! basePath: /api! tags:! - name: User! description: Ϣʔβ! produces:! - application/json :".-Ͱͷྫ
    ʢجຊ͸+40/Ͱ΋ಉ͡ʣ IUUQ
    IUUQT
    XT
    XTTͷ
    ͲΕ͔
12. Ϟσϧఆٛ ϦΫΤετ΍ϨεϙϯεͰ࢖͏σʔλܕΛϞσϧͱͯ͠ఆ͍ٛͯ͘͠ ˞
    JE
    OBNF
    BHFͱ͍͏
    
    
    
    
    ͭͷϑΟʔϧυΛ΋ͭ
    
    
    
    
    6TFSϞσϧΛఆٛ͢Δྫ definitions:! User:! type: object! properties:! id:! type: integer! description: id of user! name:! type: string! description: name of user! age:! type: number! description: age of user Ϟσϧ໊
13. paths:! /users/{id}:! get:! summary: get user list! description: xxx! parameters:! - name: id! in: path! required: false! type: integer! tags:! - User! responses:! '200'! description: user list! schema:! $ref: '#/definitions/User' "1*ఆٛ ఆٛͨ͠6TFS
    ϞσϧΛฦ͢ RVFSZ
    IFBEFS
    QBUI
    CPEZ
    GPSN%BUBͷ
    ͲΕ͔ )551ϝιου )551Ϩεϙϯεͷ
    ఆٛ෼ྻڍ