Creating Maintainable APIs: A Practical, Case-Study Approach

by Ervin Varga

Overview

Build straightforward and maintainable APIs to create services that are usable and maintainable. Although this book focuses on distributed services, it also emphasizes how the core principles apply even to pure OOD and OOP constructs.

The overall context of Creating Maintainable APIs is to classify the topics into four main areas: classes and interfaces, HTTP REST APIs, messaging APIs, and message payloads (XML, JSON and JSON API as well as Apache Avro).

What You Will Learn

• Use object-oriented design constructs and their APIs

• Create and manage HTTP REST APIs

• Build and manage maintainable messaging APIs, including the use of Apache Kafka as a principal messaging hub

• Handle message payloads via JSON

Who This Book Is For

Any level software engineers and very experienced programmers.

Product Details

ISBN-13:	9781484221952
Publisher:	Apress
Publication date:	11/15/2016
Edition description:	1st ed.
Pages:	293
Product dimensions:	7.01(w) x 10.00(h) x (d)

About the Author

Ervin Varga is in the software industry as a professional software engineer since 1994. He is an IEEE Software Engineering Certified Instructor, and an assistant professor at the University of Novi Sad, Faculty of Technical Sciences, Novi Sad, Serbia. As an owner of the software consulting company Expro I.T. Consulting, he is always in touch with production software. Consequently, he does posses production level expertise with the content of this book. Lastly, Ervin has a M.Sc. from computer science, and a Ph.D. from electrical engineering (my thesis was an application of software engineering/computer science in the domain of electrical power systems).

Table of Contents

1. Information Hiding and APIs
2. Modular Design
3. Designing Classes for Reuse
4. TDD as an API Design Technique
5. Identifying Resources
6. Versioning REST APIs
7. Encoding Actions on Resources
8. Implementing Synchronous and Asynchronous REST APIs
9. Documenting REST APIs
10. Testing REST APIs
11. Implementing Messaging APIs
12. Apache Kafka as a Messaging Hub
13. Testing Messaging APIs
14. Schema Based Messages
15. The Core JSON API
16. Evolving the JSON API
17. Katharsis