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

presented on PHP BLT #8
https://phpblt.connpass.com/event/61936/

Transcript

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

   View Slide

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

   View Slide

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

   View Slide

4. ղܾͯ͠·ͤΜ
   

   View Slide

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

   View Slide

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

   View Slide

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

   View Slide

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

   View Slide

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

   View Slide

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

    View Slide

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

    View Slide

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

    View Slide

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

    View Slide

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

    View Slide

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

    View Slide

16. View Slide

17. View Slide

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

    View Slide

19. View Slide

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

    View Slide

21. ΊΜͲ͍͘͞…
    

    View Slide

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

    View Slide

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

    View Slide

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

    View Slide

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

    View Slide

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

    View Slide

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

    View Slide

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

    View Slide

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

    View Slide

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

    View Slide

31. View Slide

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

    View Slide

33. ঃʑʹ๨ΕڈΒΕΔ
    

    View Slide

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

    View Slide

35. View Slide

36. Excelӡ༻։࢝
    

    View Slide

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

    View Slide

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

    View Slide

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

    View Slide

40. ݱࡏਐߦܥ
    

    View Slide

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

    View Slide

42. View Slide

43. View Slide

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

    View Slide

45. Insomnia Teams ܖ໿
    

    View Slide

46. View Slide

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

    View Slide

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

    View Slide