api 文件大亂鬥 @ mopcon 2013
DESCRIPTION
沒把工商服務講完 閃電秀挑戰失敗 XD Anyway,歡迎加入 Tainan.py: http://www.meetup.com/Tainan-py-Python-Tainan-User-Group/TRANSCRIPT
![Page 1: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/1.jpg)
Joe @ MOPCON 2013
API 文件大亂鬥
![Page 2: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/2.jpg)
分享各式各樣撰寫文件的方法
![Page 3: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/3.jpg)
1. 不寫 API
什麼時候 可能不用撰寫文件
2. 自己全包前後端
Parse, Firebase, deployd ...
![Page 4: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/4.jpg)
喬巴式馬賽克
Parse -> 好用
罩門 複雜資料 受限代管 需要淺淺
小結論:有規模可考慮自己架 Server ...
![Page 5: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/5.jpg)
回到正題各種撰寫文件的方法
![Page 6: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/6.jpg)
直接講變種:Line, FB, Hipchat ...
解一
![Page 7: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/7.jpg)
情境
誒,oxoxox API 怎麼用啊 ?
前天不是講過了 ...
![Page 8: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/8.jpg)
BJ4
評估
很糟糕
喬巴式馬賽克
![Page 9: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/9.jpg)
直接寫演化:txt, doc, google doc ...
解二
![Page 10: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/10.jpg)
情境
閱
請參閱
拍謝,修過程式!文件未更新
三天後
怎麼不能用?
![Page 11: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/11.jpg)
需要維護 越詳細越需人力
評估
適用小專案
![Page 12: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/12.jpg)
用工具寫站在巨人的肩膀上
解三
![Page 13: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/13.jpg)
![Page 14: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/14.jpg)
![Page 15: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/15.jpg)
![Page 16: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/16.jpg)
![Page 17: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/17.jpg)
![Page 18: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/18.jpg)
情境
寫好沒?先學寫文件先,等
正要開始寫
三天後
寫好沒?
![Page 19: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/19.jpg)
學習成本不一 (有些)仍然有同步問題
評估
的確還不錯
![Page 20: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/20.jpg)
要站在巨人的肩膀上其實不容易 ...
![Page 21: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/21.jpg)
接下來提供不寫文件的方式寫文件怎麼可能
![Page 22: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/22.jpg)
請同事自己看 Code會被揍飛
解四
![Page 23: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/23.jpg)
用框架自動生成例如:Django Rest Framework
解五
![Page 24: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/24.jpg)
![Page 25: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/25.jpg)
情境
讚!
如果我會該框架的話
![Page 26: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/26.jpg)
請參閱各語言框架
評估
程式與文件合一
![Page 27: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/27.jpg)
自幹自動生成Non-Django Framework
解六
![Page 28: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/28.jpg)
+
![Page 29: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/29.jpg)
使用 Form Validation 定義 Input 格式
![Page 30: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/30.jpg)
寫個 Decorator 截取文件所需的資訊
Done ?
![Page 31: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/31.jpg)
沒有測過的文件不能相信
通過測試就存起來
![Page 32: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/32.jpg)
再來就是輸出網頁
![Page 33: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/33.jpg)
![Page 34: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/34.jpg)
![Page 35: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/35.jpg)
需建構成本 開發環境 Only
評估
也還不錯
![Page 36: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/36.jpg)
歡迎分享其他方法
總結
自取所需
![Page 37: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/37.jpg)
工商服務
![Page 38: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/38.jpg)
![Page 39: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/39.jpg)
X
![Page 40: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/40.jpg)
更多 Python
![Page 41: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/41.jpg)
Tainan.py 聚會時間 • 每個月最末周周六 14:00 舉辦
• 下一次暫定:11/30 (六) 14:00
![Page 42: API 文件大亂鬥 @ MOPCON 2013](https://reader034.vdocuments.mx/reader034/viewer/2022052122/5489acaeb47959ec0c8b5a09/html5/thumbnails/42.jpg)
QA請勿詢問本月 10/26 為什麼沒舉辦聚會