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