Creating Maintainable APIs

1. Front Matter

   Pages i-xix

   PDF

2. Information Hiding and APIs

   • Ervin Varga

   Pages 1-16

3. Modular Design

   • Ervin Varga

   Pages 17-43

4. Designing Classes for Reuse

   • Ervin Varga

   Pages 45-67

5. TDD as an API Design Technique

   • Ervin Varga

   Pages 69-95

6. Identifying Resources

   • Ervin Varga

   Pages 97-107

7. Versioning REST APIs

   • Ervin Varga

   Pages 109-118

8. Encoding Actions on Resources

   • Ervin Varga

   Pages 119-133

9. Implementing Synchronous and Asynchronous REST APIs

   • Ervin Varga

   Pages 135-141

10. Documenting REST APIs

    • Ervin Varga

    Pages 143-157

11. Testing REST APIs

    • Ervin Varga

    Pages 159-169

12. Implementing Messaging APIs

    • Ervin Varga

    Pages 171-185

13. Apache Kafka as a Messaging Hub

    • Ervin Varga

    Pages 187-201

14. Testing Messaging APIs

    • Ervin Varga

    Pages 203-213

15. Schema-Based Messages

    • Ervin Varga

    Pages 215-227

16. The Core JSON API

    • Ervin Varga

    Pages 229-247

17. Evolving the JSON API

    • Ervin Varga

    Pages 249-267

18. Katharsis

    • Ervin Varga

    Pages 269-288

19. Back Matter

    Pages 289-293

    PDF

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.

• APIs
• maintainable
• software
• oo
• object oriented
• programming
• IEEE
• REST
• JSON

• Expro I.T. Consulting, Kikinda, Serbia

  Ervin Varga

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).

Policies and ethics