python - 编写api时需要一些建议

Question

Closed. This question is opinion-based。它当前不接受答案。
                            
                        
                    
                
                            
                                
                
                        
                            
                        
                    
                        
                            想改善这个问题吗？更新问题，以便 editing this post用事实和引用来回答。
                        
                        2年前关闭。
                                                                                            
                
        
我将要编写一个不会为其开发用户界面的应用程序。
该应用程序与数据库一起使用并处理DB中的数据。

我的问题是：


什么是最好的独立于编程语言的api方法，以便人们可以为我的应用程序编写Web界面，cli界面或桌面应用程序界面？


我用Python编写应用程序，大多数数据以json格式存储。

谢谢，

杰伊

最佳答案

我不确定您到底要什么，但是我想您正在寻找最佳的API设计模式。

我建议您注意以下要点：


实施RESTful接口
提供多种数据格式（JSON，XML等）
使语法直观易懂
详尽的文档
使用正确的响应码


另外，以下一些链接可能会有用：


  http://www.slideshare.net/eaton/building-apis-that-rock
  http://www.notiondesign.ca/blog/story/how-not-to-build-an-api/
  http://blog.apigee.com/category/api_best_practices/
  http://blog.isnotworking.com/2007/05/api-design-guidelines.html


另外，这是一本很棒的书，可以帮助您入门：


  http://www.amazon.com/dp/0596529260/

关于python - 编写api时需要一些建议，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/6457346/

上一篇：python - 在单元测试结束之前，assertRaises 中的函数会完成吗？

下一篇：python - AppEngine - AppEngine HR 数据存储中奇怪的 ID 分配

相关文章：

python - 使用 ReportLab 添加到 PDF 时 PNG 模糊

architecture - MNesia 是否支持断线操作后的同步？

api - 在发货时创建发票和捕获

javascript - OpenWeather API 错误

c# - 由于内存泄漏，Xamarin Forms 应用程序重新架构)

java - MVC 中有多少个 View 对象实例

python - 如何在开放式简历中使ROI线移动或让用户用鼠标绘制它

python - 在 matplotlib 图的交互式导航中保留缩放设置

python - 日期时间元组到秒元组

laravel - 如何在 Laravel 7 中的 Http 请求中设置代理？

Answer 1

我不确定您到底要什么，但是我想您正在寻找最佳的API设计模式。

我建议您注意以下要点：


实施RESTful接口
提供多种数据格式（JSON，XML等）
使语法直观易懂
详尽的文档
使用正确的响应码


另外，以下一些链接可能会有用：


  http://www.slideshare.net/eaton/building-apis-that-rock
  http://www.notiondesign.ca/blog/story/how-not-to-build-an-api/
  http://blog.apigee.com/category/api_best_practices/
  http://blog.isnotworking.com/2007/05/api-design-guidelines.html


另外，这是一本很棒的书，可以帮助您入门：


  http://www.amazon.com/dp/0596529260/