Code Monkey home page Code Monkey logo

hchohan / lifecycle Goto Github PK

View Code? Open in Web Editor NEW

This project forked from postman-open-technologies/lifecycle

0.0 0.0 0.0 21.26 MB

Defining the API lifecycle in a modular, reusable, and machine readable way that can help others learn about what the API lifecycle could be, as as define their own evolving API lifecycle.

Home Page: https://postman-open-technologies.github.io/lifecycle/products/

License: Apache License 2.0

JavaScript 1.08% CSS 11.11% HTML 87.81%

lifecycle's Introduction

API Lifecycle & Governance Blueprints

This is our Git managed process for centralizing the ideation and creation of consistent content, providing a single reference for concepts across the API lifecycle and operations--feel free to use, fork, and submit any content.

Blueprints

A blueprint is just a concept. It begins with an idea, grows with discussion and research, and then becomes an outline, which can be used as a buffet of concepts to work with when producing blog posts, videos, decks, and other reusable content.

Postman

These are blueprints that are specific to Postman, and how we operate different aspects of Open Tech.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
What is Postman Open Technologies View View View View none none none none draft
Open Technologies Standards Support View View View none none none none none draft

Introductory

These are a handful of high-level introductory blueprints meant for the widest possible audience.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
What is an API View View View none none View none none draft
What is API-First View View View none none View none none draft
Why do you become API-First View View none none View none none draft
How do you become API-First View View none none View none none draft
What is API-Early View View View none none none none none draft
What is API-Aware View View View none none none none none draft

History of APIs

Understanding more about how we got to this point in time, exploring the evolution of whath we now know as APIs.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
History of APIs View View View none none none none V1
History of Web APIs View View View none none none none none draft
Business in the Clouds View View View none none none none none draft
Our Lives Going Mobiles View View View none none none none none draft
The API Economy View View View none none View none none draft
Devices in our Physical World View View View none none none none none draft
Strengthening Partnerships View View View none none none none none draft
Microservicess View View View none none none none none draft
Applications View View View none none none none none draft
Integrations View View View none none none none none draft

Digital Value

These are the units of value that define business today and are being defined as APIs, providing the atomic unit of the API economy.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Resources View View View none none none none none draft
Capabilities View View View none none none none none draft

Challenges / Solutions

Defining some of the common challenges faced by API producers and consumers when it comes to working with APIs, and pairing as solution.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Usability View View View none none none none none draft
Stability View View View none none none none none draft
Trust View View View none none none none none draft
Motion View View View none none none none none draft
Advantage View View View none none none none none draft

Toolbox

Articuating what a diverse API toolbox looks like today, going well beyond just what is possible with simple web APIs.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Synchronous View View View none none none none none draft
Asynchronous View View View none none none none none draft
Protocols View View View none none none none none draft
Patterns View View View none none none none none draft

Contracts

Defining all of the ways in which you can define a contract for an API, providing a machine readable definition of each API.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Contracts View View View none none none none none draft
OpenAPI View View View none none none none none draft
AsyncAPI View View View none none none none none draft
JSON Schema View View View none none none none none draft
Protocol Buffers View View View none none none none none draft
Collections View View View none none none none none draft
GraphQL View View View none none View none none draft
WSDL View View View none none none none none draft
Schema Registry View View View none none none none none draft

Producer Lifecycle

The view of the lifecycle from the producers perspective, looking at how APIs are brought to life and evolved over time, here is a deck being developed to define this side of the API lifecycle

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Define View View View none none none none none draft
Design View View View none none none none none draft
Develop View View View none none none none none draft
Test View View View none none none none none draft
Secure View View View none none none none none draft
Deploy View View View none none none none none draft
Observe View View View none none none none none draft
Distribute View View View none none none none none draft

Entry Points

Acknowledging that there are many ways in which the lifecycle can be entered, depending on the team and the type of API being delivered, here is a blog post that tells the story of this entire area of blueprints.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Design First View View View none none none none none draft
Code-First View View View none none none none none draft
Prototype-First View View View none none none none none draft
Proxy-First View View View none none none none none draft

Consumer Lifecycle

The view of the lifecycle from consumer perspective, looking at how the APIs are being put to work in a variety of applications, here is a deck to expore this side of the API lifecycle.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Discover View View View none none none none none draft
Evaluate View View View none none none none none draft
Develop View View View none none none none none draft
Test View View View none none none none none draft
Observe View View View none none none none none draft

Legacy

Understanding how APis are being used to address legacy infrastructure, helping decompose and deliver as simple APIs.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Legacy View View View none none none none none draft

Operational

Looking at the operational side of defining an API platform, understanding the cornerstones of API operations and the lifecycle.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Organization View View View none none none none none draft
Workspaces View View View none none none none none draft
Source Control View View View none none none none none draft
CI/CD View View View none none none none none draft
Gateways View View View none none none none none draft
APM View View View none none none none none draft
Platform View View View none none none View 1 2 3 none draft

Landscape

Mapping out the digital enterprise landscape to help "see" the digital resources and capabilities that are in use behind applicatinos and integrations.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Discoverable View View View none none none none none draft
Observable View View View none none none none none draft
Automated View View View none none none none none draft
Changing View View View none none none none none draft

Productivity

Understand what defines and improves the productivity across teams when it comes to the API lifecycle.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Team Performance View View View View none none none View draft

Quality

Understanding the fundamentals of qualityi across APIs, helping define a baseline when it comes to quality across API operations.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Quality View View View none none none none none draft
Contract Testing View View View none none none none none draft
Performance Testing View View View none none none none none draft

Governance

Being able to understand the state of the enterprise sytem, then gain the observabilitiiy and control to steer things in the right direction.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Governance View View View none none none none none draft
Guidelines View View View none none none none none draft
Design Governance View View View none none none none none draft
Design Review View View View none none none none none draft
Security Review View View View none none none none none draft
Platform Governance View View View View none View none View draft
Standards View View View none none none none none draft
Centralization View View View none none none none none draft
Federation View View View none none none none none draft
Rules View View View none none none none none draft
Templates View View View none none none none none draft

Shifting Left

Moving API testing, security, and governance earlier on in the API lifecycle, helping enable to do the right thing as early on as possible.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Shift-Left View View View none none none none none draft

Regulations

Breaking down the different layers of API-related regulation emerging around the globe, and how APIs are being used to respond to regulations.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Regulations View View View none none none none none draft
Privacy Regulations View View View none none none none none draft
Interoperability Regulations View View View none none none none none draft
Regulations Automation View View View none none none none none draft

Business

Understanding the business of APIs, and why APIs are increasingly defined as products, and how business stakeholders are getting more involved.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Business View View View none none none none none draft
APIs as a Product View View View none none none none none draft
Product Management View View View none none none none none draft
Developer Experience View View View none none none none draft
Visibility View View View none none none none none draft
Productivity View View View none none none none none draft
Low Code / No Code View View View
Innovation View View View none none none none none draft
Composable View View View none none none none none draft
Collaborative View View View none none none none none draft
Interoperable View View View none none none none none draft
Future-Proof View View View none none none none none draft
World Building View View View none none none none none draft
Category Defining View View View none none none none none draft

Knowledge

Looking at the knowledge that is needed to help teams be successful when it comes to producing and consuming APIs inside and outside the firewall.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Education View View View none none none none none draft

Public Facing

These are blueprints focused on the public facing aspects of our API operations, and what we should be considering as we evolve operations.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Team Profile View View View none View View View none draft
Workspace Checklist View View View none View View none none draft
Documentation Checklist View View View none View View none none draft
Public Workspace Engagement View View View none View View none none draft
Time to First Call View View View none View View none none draft
Portal and Network View View View none none View none none draft

Where to Start

These are some of the common answers to enterprise organizations asking where they should start when getting more organized with their API journey.

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Landscape Mapping View View View none none none none none draft
Ad Hoc Landscape View View View none none none none none draft
Strategy View View View none none none none none draft
Lifecycle View View View none none none none none draft
Enablement View View View none none none none none draft
Forward Motion View View View none none none none none draft

Open Data & Research Intelligence

Knowledge and guidance around the modernization of open data APIs and the establishment of standards and service driven solutions to support scientific research and machine intelligence.

Fundamentals

Name Ideas Discussions Outline Deck Slide Blog Video PDF Status
Why data matters View none none none none none none none draft
The need for digital knowledge View none none none none none none none draft

Process

The process we are using to move blueprints forward is an ever evolving one, but to help encourage participation across the team, and even from the community, here are steps we are taking to create new blueprints, and iterate upon existing ones.

  • Ideas - Use a miro board to get all the concepts on the table in a visual way.
  • Discussion - Use Github issue to discuss each concept as we iterate upon.
  • Outline - Use individual markdown files as the source of outline for each version.
  • Deck - Create a deck to convey the concept for use in demos and presentations.
  • Slide - Create a single slide to convey the concept for use in slide decks.
  • Blog - Publish a blog post to support the concept and help tell the sotry.
  • Video - Publish a video using Space Camp, Exploratory, or Level Up process.
  • PDF - Create a one sheet PDF that can be easily shared with anyone via email or link.

This process will continue to evolve as we move forward with more blueprints. This set of instructions is designed to focus on fleshing out as many blueprints as possible, providing areas and elements for each, but then iterating upon actions and other links, videos, and resources with future versions--we will shift the process as we progress.

I'd like to see more scheduling and distribution as part of this, but just focusing on creating as many blueprints, and supporting blog, vidoes, and other content.

lifecycle's People

Contributors

kinlane avatar mjgutermuth avatar matthewreinbold avatar kulnor avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.