RESTful API Design — A practical guide

此篇文章將作為接下來一系列關於Restful API design的目錄．

Part 1: 將介紹什麼是API，何時需要他，以及怎樣才會是一個好的API．

Part 2: 在許多種API中，此系列只專注於HTTP RESTful API，為了更好地學習他，必須先了解HTTP Protocol，知道其中各個組成HTTP Message的每一個部分．

Part 3: 介紹何為RESTful API，為什麼他會長這樣，以及其他許多當你在設計API時會遇到情況，例如: Documentation、Pagination、Rate Limiting、Monitoring．

Part 4: 陸續想到一些相關的議題，再放上來！

Outline

1. Introduction
2. 1.1 What is an API?
3. 1.2 What is a good API?
4. HTTP Basics
5. 2.1 A HTTP Overview
6. 2.2 HTTP Methods
7. 2.3 HTTP Response status codes
8. 2.4 HTTP URI
9. 2.5 HTTP Headers
10. 2.6 [Practices] A HTTP client — curl
11. RESTful API and some Practical Guidelines
12. 3.1 What is a RESTful API?
13. 3.2 Identifying Resources
14. 3.3 API first principle and an introduction to OpenAPI
15. 3.4 [Practices] How do I manage a large OpenAPI spec file?
16. 3.5 Pagination
17. 3.6 Rate Limiting
18. 3.7 Monitoring
19. Advanced Topics
20. 4.1 Connection management
21. 4.2 Resource Modeling: Fine-grained or Coarse-grained?
22. 4.3 Versioning and Compatibility
23. 4.4 How to Response to a Health Check?