Upgrade to Pro — share decks privately, control downloads, hide ads and more …

API仕様書ってどう運用したらいいの? / api_doc

API仕様書ってどう運用したらいいの? / api_doc

Jun Watanabe

August 08, 2017
Tweet

More Decks by Jun Watanabe

Other Decks in Programming

Transcript

  1. API࢓༷ॻ͕
    ؾ͍ͮͨΒ
    Excelʹͳͬͯͨ

    View full-size slide

  2. API࢓༷ॻ͕
    ؾ͍ͮͨΒ
    Excelʹͳͬͯͨ

    View full-size slide

  3. ͍ͬͯ͏
    ጻչΛ͠·͢

    View full-size slide

  4. ղܾͯ͠·ͤΜ

    View full-size slide

  5. Twitterͱ͔࠙਌ձͰ
    ͥͻͥͻ

    View full-size slide

  6. API࢓༷ॻͬͯ
    Ͳ͏ӡ༻͢Ε͹ྑ͍ͷ?
    2017/08/08 PHP BLT #8
    Jun Watanabe

    View full-size slide

  7. Jun Watanabe @rela1470
    • ORATTA, Inc. Chief Engineer
    • PHPer
    • αʔόʔνʔϜͰ޷͖উख
    • http://rela.red/

    View full-size slide

  8. https://www.asuka-zero.jp/

    View full-size slide

  9. ʲલఏ৚݅ʳ
    ৽ن։ൃҊ݅
    PCιʔγϟϧήʔϜ(PWA)
    αʔόʔ3ਓ+ωΠςΟϒ3ਓ
    REST API

    View full-size slide

  10. 2016೥4݄
    (ϓϩδΣΫτ࢝ಈ)

    View full-size slide

  11. ๭API
    υΩϡϝϯτ
    ʹײಈ

    View full-size slide

  12. http://docs.powerbi.apiary.io/

    View full-size slide

  13. ೖग़ྗ͕
    Θ͔Γ΍͘͢
    ·ͱ·͍ͬͯΔ

    View full-size slide

  14. ϞοΫαʔόʔ
    ࣮ࡍʹୟ͚Δ

    View full-size slide

  15. Debugging Proxy
    ࣮ࡍͷAPIΛhookͯ͠
    ݁ՌΛҰཡදࣔ

    View full-size slide

  16. εΩʔϚΛఆٛͨ͠Β
    ͦͷܕʹ߹Θͤͨ
    μϛʔσʔλΛฦͯ͘͠ΕΔ

    View full-size slide

  17. yamlͰΰϦΰϦॻ͘
    or
    Ξϊςʔγϣϯʹॻ͍ͯม׵

    View full-size slide

  18. ΊΜͲ͍͘͞…

    View full-size slide

  19. ͋ͱͰ΍Ζ͏ͱ
    ࢥͬͯ·ͨ͠

    View full-size slide

  20. apiaryΛॻ͍͔ͨͲ͏͔
    νΣοΫ͢Δද͕ग़དྷͨ

    View full-size slide

  21. ΋ͬͱΊΜͲ͍͘͞…

    View full-size slide

  22. 2016೥10݄
    (6ϲ݄໨)

    View full-size slide

  23. ୭΋ߋ৽͠ͳ͘ͳͬͨ

    View full-size slide

  24. PHPॻ͘Ҏ֎ͷ͜ͱ͸
    ΍Γͨ͘ͳ͍

    View full-size slide

  25. PHPॻ͍ͨΒ
    ࣗಈͰυΩϡϝϯτੜ੒
    ͢Ε͹ྑ͍ͷͰ͸

    View full-size slide

  26. phpDocumentor 2
    https://www.phpdoc.org/

    View full-size slide

  27. ApiGen
    http://www.apigen.org/

    View full-size slide

  28. ࢓༷มߋ͞Εͯ΋
    phpDoc͸ݹ͍··…

    View full-size slide

  29. ঃʑʹ๨ΕڈΒΕΔ

    View full-size slide

  30. 2016೥12݄
    (8ϲ݄໨)

    View full-size slide

  31. Excelӡ༻։࢝

    View full-size slide

  32. ਖ਼͘͠͸
    Google εϓϨουγʔτ

    View full-size slide

  33. ಉ࣌ߋ৽OK
    मਖ਼ཤྺ΋෼͔Δ
    ௚ײͰૢ࡞͠΍͍͢

    View full-size slide

  34. ϚΫϩ৬ਓ͕
    ࢓༷ॻ͔ΒίʔυΛ
    ࣗಈੜ੒

    View full-size slide

  35. ݱࡏਐߦܥ

    View full-size slide

  36. 2017೥5݄
    (13ϲ݄໨)

    View full-size slide

  37. 2017೥6݄
    (14ϲ݄໨)

    View full-size slide

  38. Insomnia Teams ܖ໿

    View full-size slide

  39. ౴͑͸ݟ͔ͭͬͯ·ͤΜ

    View full-size slide

  40. Twitterͱ͔࠙਌ձͰ
    ͥͻͥͻ

    View full-size slide