# restful-api-design-references

**Repository Path**: tlongc/restful-api-design-references

## Basic Information

- **Project Name**: restful-api-design-references
- **Description**: RESTful API 设计参考文献列表，可帮助你更加彻底的了解REST风格的接口设计。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-06-17
- **Last Updated**: 2021-06-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README




我创建这个 [repository](https://github.com/aisuhua/restful-api-design-references)，是因为我希望收集一些比较好的有关于 RESTful API 设计的参考文献。

如果您希望添加更多的参考文献，可以在 [issues](https://github.com/aisuhua/restful-api-design-references/issues) 中告诉我，谢谢。

### References ###

#### Articles ####

1. RESTful 最佳实践
	- [http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api](http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api) （英文原文）
	- [http://blog.jobbole.com/41233/](http://blog.jobbole.com/41233/) （中文译文1）
	- [http://www.oschina.net/translate/best-practices-for-a-pragmatic-restful-api](http://www.oschina.net/translate/best-practices-for-a-pragmatic-restful-api) （中文译文2）
2. 好RESTful API的设计原则
	- [ http://codeplanet.io/principles-good-restful-api-design/]( http://codeplanet.io/principles-good-restful-api-design/) （英文原文）
	- [http://www.cnblogs.com/moonz-wu/p/4211626.html](http://www.cnblogs.com/moonz-wu/p/4211626.html) （中文译文）
7. HTTP API 设计指南 
	- [https://github.com/interagent/http-api-design](https://github.com/interagent/http-api-design) (英文原文)
	- [https://github.com/cocoajin/http-api-design-ZH_CN](https://github.com/cocoajin/http-api-design-ZH_CN)（中文译文）
3. Some REST best practices [https://bourgeois.me/rest/](https://bourgeois.me/rest/)
4. 理解RESTful架构（阮一峰） [http://www.ruanyifeng.com/blog/2011/09/restful.html](http://www.ruanyifeng.com/blog/2011/09/restful.html)
5. RESTful API 设计指南（阮一峰） [http://www.ruanyifeng.com/blog/2014/05/restful_api.html](http://www.ruanyifeng.com/blog/2014/05/restful_api.html)
6. Thoughts on RESTful API Design https://restful-api-design.readthedocs.org/en/latest/
5. Restful API 的设计规范 [http://novoland.github.io/%E8%AE%BE%E8%AE%A1/2015/08/17/Restful%20API%20%E7%9A%84%E8%AE%BE%E8%AE%A1%E8%A7%84%E8%8C%83.html](http://novoland.github.io/%E8%AE%BE%E8%AE%A1/2015/08/17/Restful%20API%20%E7%9A%84%E8%AE%BE%E8%AE%A1%E8%A7%84%E8%8C%83.html)
6. 最佳实践：更好的设计你的 REST API [http://www.ibm.com/developerworks/cn/web/1103_chenyan_restapi/](http://www.ibm.com/developerworks/cn/web/1103_chenyan_restapi/)
8. 如何查看我的订单-REST的流程API设计案例 [http://www.infoq.com/cn/articles/rh-view-my-order-rest-api](http://www.infoq.com/cn/articles/rh-view-my-order-rest-api)
9. Web API Design - Crafting Interfaces that Developers Love [https://blog.apigee.com/detail/announcement_new_ebook_on_web_api_design](https://blog.apigee.com/detail/announcement_new_ebook_on_web_api_design) (需要翻墙)

#### Books ####

1. RESTful Web Services中文版 [http://book.douban.com/subject/3094230/ ](http://book.douban.com/subject/3094230/ )
2. RESTful Web Services Cookbook中文版 [http://book.douban.com/subject/6837645/](http://book.douban.com/subject/6837645/) 
3. RESTful Web APIs中文版 [http://book.douban.com/subject/25909247/ ](http://book.douban.com/subject/25909247/ )
4. REST实战 [http://book.douban.com/subject/6854551/](http://book.douban.com/subject/6854551/)


#### Websites ####

1. Github API v3 [https://developer.github.com/v3/ ](https://developer.github.com/v3/ )
2. Mailgun Documentation [https://documentation.mailgun.com/ ](https://documentation.mailgun.com/ )
3. Enchant REST API [http://dev.enchant.com/api/v1 ](http://dev.enchant.com/api/v1 )
4. 微博 API [http://open.weibo.com/wiki/Error_code](http://open.weibo.com/wiki/Error_code)
5. OpenNMS Wiki ReST API [http://www.opennms.org/wiki/](http://www.opennms.org/wiki/)
6. API Craft Google Group [https://groups.google.com/forum/?fromgroups#!forum/api-craft](https://groups.google.com/forum/?fromgroups#!forum/api-craft) (学习 REST 非常好的 BBS, 需要翻墙)


### Tools ###

#### Debug ####

1. DHC (aka Dev HTTP Client)  好用的 Chrome 浏览器接口调试插件 [https://www.sprintapi.com/dhcs.html](https://www.sprintapi.com/dhcs.html)
2. Fiddler2 另一个强大的接口调试工具 [http://www.telerik.com/fiddler](http://www.telerik.com/fiddler)

#### Documents ####

1. MarkdownPad2 API 文档编写 [http://markdownpad.com/](http://markdownpad.com/)
1. i5ting_ztree_toc API 文档生成 [https://github.com/i5ting/i5ting_ztree_toc](https://github.com/i5ting/i5ting_ztree_toc)

#### Highlight ####

1. highlight.js [https://highlightjs.org/](https://highlightjs.org/)