Skip to content

Commit 95fe5b0

Browse files
authored
Split OpenAPI and Design first (#106)
* fixed a bunch of missing images * accidental subfolder * merged the plan on README * quick intro to testing * finished up porting copy from bump openapi guide * integrated intro to api descriptions into openapi * moved in the perfect workflow article as the basis for this chapter
1 parent 0014d4a commit 95fe5b0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+6996
-709
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.DS_Store
22
generated/
3+
potential-images/
34
book.epub.d/
45
book.xml

README.md

Lines changed: 21 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Support the development of this book, and [**pre-order on LeanPub!**](https://le
1010
- [ ] History of APIs
1111
- [x] APIs, Services, and Microservices
1212
- [x] Understanding Different Paradigms
13+
- [ ] HTTP/1, HTTP/2 and HTTP/3
14+
- [ ] Asynchronous Methodologies
1315
- [ ] Part 2: API Design Basics
1416
- [x] Structuring URLs
1517
- [x] HTTP Methods
@@ -30,62 +32,36 @@ Support the development of this book, and [**pre-order on LeanPub!**](https://le
3032
- [ ] Part 4: API Design First Workflow
3133
- [x] Intro to API Design First
3234
- [x] API Descriptions
33-
- [ ] Part 5: Design a new API
34-
- [ ] Part 6: Managing and Maintaining an API
35-
- [ ] Part 7: Taking APIs Further
36-
- [ ] Part 8: Testing APIs
37-
38-
## Old Outline
39-
40-
How the book was looking as Phils random braindumps.
41-
42-
- [ ] Part 1: Theory
43-
- [x] APIs, Services, and Microservices
44-
- [x] Understanding Different Paradigms
45-
- [ ] API Lifecycle
46-
- [ ] Design Theory
47-
- [x] API Descriptions
48-
- [ ] Hypermedia Controls (HATEOAS)
49-
- [ ] HTTP/1, HTTP/2 and HTTP/3
50-
- [x] Asynchronous Methodologies
51-
52-
- [ ] Part 2: Planning & Design
53-
- [x] Editors
54-
- [x] Mocking
55-
- [x] Documentation
35+
- [ ] Editors
36+
- [ ] Mocking
37+
- [ ] Documentation
38+
- [ ] Contract Testing
39+
- [ ] Design Reviews
5640
- [ ] Style Guides (#33)
57-
58-
- [ ] Part 3: Building & Testing
59-
- [ ] Building Blocks
41+
- [ ] Automated SDKs
42+
- [ ] Part 5: Design a new API
6043
- [ ] Serialization
6144
- [ ] Deserialization
62-
- [ ] Debugging
63-
- [ ] Traffic Inspection
64-
- [ ] Integration Testing
65-
- [ ] Contract Testing
66-
- [ ] End to End / Acceptance Testing
45+
- [ ] Part 6: Managing and Maintaining an API
6746
- [ ] Health Checks (#36)
68-
- [ ] Load Testing
69-
- [ ] Testing in Production
70-
- [ ] Notes on Deployment
71-
72-
- [ ] Part 4: Management & Experience
47+
- [ ] Traffic Inspection
48+
- [ ] Deprecation (#34)
7349
- [ ] Portals & Documentation
7450
- [ ] API Gateways
7551
- [ ] Gateway Validation
76-
- [ ] Rate Limiting
7752
- [ ] Analytics
7853
- [ ] Governance
79-
- [ ] Deprecation (#34)
80-
- [ ] Versioning & Evolution (#35)
81-
82-
- [ ] Part 5: Further Theory
54+
- [ ] Part 7: Taking APIs Further
8355
- [ ] Picking Paradigms (#37)
8456
- [ ] Common Architectures
8557
- [ ] GraphQL as a Monolith
8658
- [ ] REST wrapping Microservices
8759
- [ ] Backend for Frontends (BFFs)
88-
89-
## Preview
90-
91-
[PDF Preview](https://github.com/apisyouwonthate/book-build-apis-2/raw/master/generated/book.pdf)
60+
- [ ] Part 8: Testing APIs
61+
- [ ] Poking it with an API Client
62+
- [ ] Integration Testing
63+
- [ ] Contract Testing
64+
- [ ] End-to-End Testing
65+
- [ ] Fuzz Testing
66+
- [ ] Load Testing
67+
- [ ] Security Testing

0 commit comments

Comments
 (0)