Book
Web API: The Good Parts
Takaaki Mizuno
Summary
A Japanese-language guide to designing, developing, and operating Web APIs by Takaaki Mizuno. It argues that an API can become hard to use through its design choices alone, and that this also makes maintaining and operating it after release difficult, so designing it beautifully matters. Working from the idea that a beautifully designed API is easy to use, easy to change, robust, and not embarrassing, the book clarifies how to design and operate an API more effectively, and what to watch for in order to avoid common traps and pitfalls. Its target is the simple type of API where accessing a URI returns data such as XML or JSON, namely the XML-over-HTTP and JSON-over-HTTP styles. Readers come away knowing the thinking and techniques behind Web API design.
Target Readers
- Developers settling the design of a JSON-over-HTTP or XML-over-HTTP API before release, when that design will also decide how hard it is to maintain and operate afterward
- Engineers working on RESTful API development who need to know the common traps and pitfalls in endpoint design and HTTP method use
- Developers who need explicit criteria for judging an API design: easy to use, easy to change, robust, and not embarrassing
Tags
Colophon
- Publisher
- O'Reilly Japan
- ISBN
- 978-4873116860
- Published
- Nov 2014
- List price
- ¥2,420incl. taxMay differ from the actual selling price on Amazon
Get this book
* The link above is an advertisement via Amazon Associates.Related Books
Prerequisites
- Recommended
Mastering TCP/IP Nyumon-hen, 6th Edition (Mastering TCP/IP: Introductory Volume)
Naoya Inoue, Yukio Murayama, Takafumi Takeshita, Toru Arai, and Yukio Karita
Reason: Once you understand how TCP/IP and HTTP work, the design decisions of REST APIs built on top of them make sense down to the 'why.' Web API: The Good Parts offers practical guidance on URIs, methods, and status codes grounded in HTTP semantics.
- Recommended
Web o Sasaeru Gijutsu (The Technology That Supports the Web)
HTTP, URI, HTML, and REST
Yohei Yamamoto
Reason: Once you have the Web's foundational technologies down, you move to the practice of designing 'good APIs' with them. Web API: The Good Parts offers established patterns for URI design, error representation, and versioning faithful to HTTP semantics, turning principles into design decisions.
- Related
Clean Code
A Handbook of Agile Software Craftsmanship
Robert C. Martin
Reason: A sense for good code carries over from the inside of functions and classes to the design of the APIs you expose. The Clean Code principles of naming, consistency, and predictability extend naturally to URIs and response design—the 'public names' of an API.
Next Books
- Recommended
The Design of Web APIs
Arnaud Lauret
Reason: Once you've grasped the basics of REST design, you advance to describing and sharing an API as a 'contract.' The Design of Web APIs presents a spec-driven design process with OpenAPI, giving you a repeatable way to build consistent APIs across a team.
- Recommended
OpenID Connect Nyumon (Introduction to OpenID Connect)
Practical Technical Guide for Application Developers
Kohei Toki
Reason: Once you can design an API, you need an authentication and authorization layer that controls who may call it and with what privileges. OpenID Connect standardizes identity verification on top of OAuth 2.0, providing the established way to build token-based access control into an API.
- Related
Learning GraphQL
Declarative Data Fetching for Modern Web Apps
Eve Porcello, Alex Banks
Reason: Understanding REST design throws GraphQL's ideas into relief as an answer to REST's constraints—over-fetching and round trips. Learning GraphQL teaches client-driven queries and a schema-driven type system, giving you criteria for choosing between the two.
- Related
gRPC: Up and Running
Building Cloud Native Applications with Go and Java for Docker and Kubernetes
Kasun Indrasiri, Danesh Kuruppu
Reason: With text-based REST in hand, you broaden your view to gRPC as a high-efficiency option for service-to-service communication. gRPC: Up and Running teaches contract definition with Protocol Buffers and bidirectional streaming, presenting a practical answer for internal microservice communication.