Purpose
The purpose of this document is to explain the concepts and practices relevant to taking an API First approach to creating microservices that are intended to run within th edgeEngine ecosystem.
Intended Readers
The intended readers of this document are software developers, system engineers, application architects, deployment and security personnel as well as other technical professionals who want to understand the details and benefits of taking the API First approach for developing microservices that will run under the edgeEngine runtime.
What You Will Learn from this Document
After reading this document you will:
- Understand the reasoning behind the API First approach to microservice development
- Understand how the API First approach is implemented in the edgeEngine ecosystem using the Swagger/OpenAPI specification format
- Understand the general structure of an edgeEngine microservice when defined using the API First approach and the Swagger/OpenAPI specification format
- Understand how to use edgeEngine development tools to automatically generate boilerplate code for an edgeEngine microservice
- See an example of a Swagger/OpenAPI specification that defines edgeEngine microservice
What You Need to Know Before You Start
In order to get full benefit from reading this document, you need to have:
- A general understanding of developing RESTful APIs in a distributed environment
- A working knowledge of the Swagger/OpenAPI 2.0 specification format
- A working knowledge of the edgeEngine Runtime and how it supports microservices
- A general knowledge of how to create microservices that run in the edgeEngine ecosystem
Understanding the API First Approach
[TO BE PROVIDED]
[TO BE PROVIDED]
An Example API Specification
[TO BE PROVIDED]