API Design and Development

After completing this course you should be able to:

• Describe the architectural traits and patterns that improve application maintainability
• Describe the architectural traits and patterns that improve application serviceability
• Identify steps to design and build a ChatOps application
• Implement robust Representational State Transfer (REST) API integrations with network error handling, pagination, and error flow control
• Describe the necessary steps for securing user and system data in applications
• Describe the necessary steps for securing applications
• Identify common tasks in automated application release process
• Describe best practices for application deployment
• Describe methodologies for designing distributed systems
• Describe the concepts of infrastructure configuration management and device automation
• Utilize Yet Another Next Generation (YANG) data models to describe network configurations and telemetry
• Compare various relational and nonrelational database types and how to select the appropriate type based on requirements

 

• No specific Pre-requisites
• Knowledge of various toolsets is beneficial
• Knowledge of Java / JSON is beneficial
• Knowledge of Security Principles is beneficial
  • Following tools are requiredMiro
  • Swagger.io
  • cURL
  • Postman

DAY 1

• Provide an introduction to API Development at the Dept of Home Affairs

This topic will cover what are APIs, what are the key components that make up an API, how is API design different from SOA. It’ll also cover the EISS Sub Strategy that the Department is implementing.

• Overview of Domain Driven Design Methodology

This topics cover the theory of Domain Driven Design. It goes through the key concepts of DDD like Ubiquitous Language, Bounded Contexts, Context Mapping, Value Objects and many more. The topic will also cover the Town Plan and the 10 rules of DDD in place at the Department. The students will design their own API based on a use case provided.

DAY 2

• Department Guidelines in Creating APIs

Next we deep dive into how to create a Swagger definition of an API. It will go through the structure of an API specification as well as provide Departmental guidelines for each component of the API. Exercises will put these learnings into Practice.

• Steps to Publish APIs

This topic will introduce the students to the Developer Portal and how to publish their APIs. It will also touch on how to auto generate code for their API and various tools that can be used to aid in the development.

DAY 3

• Overview of how to Consume APIs

This topics covers how to use other APIs as well as how to Test them using common tools.

• Introduction to Security and OAuth2

This topic covers API security and touches on OAuth2 as one method of implementing security into APIs

• Best Practices and Pitfalls
• The course finishes will some recommendations and things to look out for when developing APIs.