Blueprint: New API Using the AsyncAPI Specification

This is a blueprint to try and define a new event-driven API using AsyncAPI, pushing the boundaries of this API lifecycle blueprint to include multiple protocols, patterns, and ensure that there can be a well defined API lifecycle across a diverse set of approaches to delivering APIs.

This Blueprint is Still in Draft Mode and Will Be Rapidly Changing!

At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus. Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.


Define

Ensuring that operations supporting an API is properly defined, as well as what is needed to properly design and bring an API to life. A little planning and organization at this step of an APIs journey can go a long way towards ensuring the overall health and velocity of an API, and the applications that depend on this internal, partner, or public API.

  • Use Cases - Establishing a list of real world business uses cases of an API helps clarify the purpose an API, ensuring that the design and development of the API matches the business objects, and the needs of potential consumers.
  • Schema - Defining all objects use as part of API operations using JSON Schema provides for a definitions that can be used as part of modeling and the API design process, as well as for validation at development, build, or even run time.
  • Events - Meaningful occurrences across business operations that triggers notifications or make calls to other APIs when resources are added, updated, deleted, viewed, or other action is taken with an individual API or the operations surrounding the API, making activity across API operations more interactive, dynamic, and alive.

Develop

Provide a mock for the API.

  • Code - Instructions for a computer program in any language that can be used to power APIs on the back or integrate, automate, and orchestrate on the client side, providing executable instructions that accomplish a specific business object, providing what operations needs to power information technology across an organization.
  • Business Logic - The custom rules or algorithms that handle the exchange of information between a database and user interface, defining the logic that exists in between APIs and backend systems, allowing data, content, media, and other resources to be transformed, remixed, and personalized for consumers, optimizing the overall experience.

Operate

Operate an API in production.

  • Deploy - Using an API gateway to deploy and manage APIs provides a single or federated approach to providing access to backend services using well defined APIs, standardizing how APIs are published to development, staging, production, or other environments, while also consistently apply authentication, logging, and the other elements needed to properly manage APIs at scale.
  • Secure - Ensuring that an API is secure from threats and vulnerabilities, making for a pretty wide spectrum of different processes and technologies that ensure digital resources and capabilities made available via APIs are only accessible to an intended audience and bad actors are not able to find ways to get access via an API.
  • Audit - Auditing the usage and operations of each API, or a group of APIs to understand how APIs work, what dependencies are to understand the actual state of any part of API infrastructure is performing or under-performing, to better inform the road map for API operations.
  • Monitor - Monitoring any process across API operations defined as a collection, then bundled with any environment, setting a schedule for the execution of the collection, and viewing or publishing of the results to any other location, providing a very wide definition of what monitoring can mean across API operations.
  • Inform - Ensure that all stakeholders for an API have all the relevant facts and information regarding an API, keeping teams behind APIs up to speed all what they need to know to design, develop, and manage an API across it's evolution, allowing everyone to make the best possible decisions when it comes to delivering APIs.

Discover

Discovery involving an API.

  • Events - Meaningful occurrences across business operations that triggers notifications or make calls to other APIs when resources are added, updated, deleted, viewed, or other action is taken with an individual API or the operations surrounding the API, making activity across API operations more interactive, dynamic, and alive.
  • Relationships - Defining and understanding the way in two concepts, objects, or people are connected with APIs, helping connect the dots between the more human and business operations side of how APIs work, acknowledging that people and process are a critical part of how APIs work, and will influence there usage and evolution over time.


Discussions

YAML

Printable

Slide Deck

Return to Main Page

This provides a link back to the home page if you need it.