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.
100 Series Blueprints
- What is an API?
- How to Think About APIs
- The Early Seeds of APIs
- APIs in Commerce and Social Media
- The API Moves to the Cloud
- Who Uses APIs?
- Why Are APIs Used?
- Where Are APIs?
- Applications
- API-Early
- History of Web APIs
- Applications
- Requests
- Workspaces
- Internet of Things (IoT)
- HTTP Client
- Collections
- Authentication
- Documentation
- API-First
- Reference Collections
- Producer - Testing
- Environments
- Producer - Define
- REST
- GraphQL
- Ad Hoc Landscape
- JSON Schema
- WSDL
- Producer - Develop
- Code-Led
- Legacy
- Source Control
- Versioning
- Collaboration
- Lifecycle Essentials
- Producer Lifecycle
- Consumer Lifecycle
- Variables
- Integrations
- Producer - Deploy
- Consumer - Discover
- Consumer - Evaluate
- Discoverability
- OpenAPI Contracts
- Landscape Mapping
- Performance Testing
- Workspace Checklist
- Search
- Mobile
- Partnerships
- Protocols
- Continuous Integration & Continuous Deployment (CI/CD)
- Gateway Capabilities
- Clients
- Business Workflows
- Consumer - Integrate
200 Series Blueprints
- Marketing
- API-Aware
- Code Annotations
- SOAP
- Products
- Design Mock Servers
- Testing Mock Servers
- Clouds
- The API Economy
- Digital Resources
- Synchronous interactions
- Asynchronous interactions
- Producer - Design
- Producer - Distribute
- Proxy-Led
- Consumer - Test
- Access
- Team Profile
- Low-Code / No-Code
- Usability
- Stability
- Trust
- Motion
- Advantage
- Collaborative
- Contract Testing
- Webhooks
- OWASP Top 10
- Mock Servers
- Workspace Publicity
- Time to First Call
- Microservices
- Prototype-Led
- Sales Strategy
- Quality Reviews
- Document Checklist
- Test Automation
- Websockets
- Capabilities
- Low Level API Governance
- Quality
- Platform Base
- Builder
- Security Collections
- Strategy
- Versioning Governance
- AsyncAPI Contracts
- Consumer - Observe
- Design Reviews
- Organizations
- Contracts
- Education
- Postman Sandbox
- Banking Industry Architecture Network (BIAN) Contract Testing
- Onboarding Collections
- Producer - Secure
- Platform API Governance
- Gateway Solutions
- gRPC
- Patterns
- Protocol Buffers
- Centralization
- Templates
- Security Reviews
- Enablement
- Jobs to Be Done
- Experiences
- Domain-Driven Design (DDD)
- Consumer - Deploy
- Gateway Dimensions
- Regions
- Change Management
- Roles
- Analytics
- Productivity
- Shifting Left
- Automation
- Education
- Postman Open Technologies
- Open Technologies Standard Support
- Why do you become API-first?
- API Program Lifecycle
- Buttons
- Public Workspaces
- Producer - Observe
- Application Performance Management (APM)
- Guidelines
- Privacy Regulations
- Expansion
- Open Source
- Managing Governance
- Observability
- Governance Shape
- Maturity
- Rules
- Integrated Development Environments(IDE)
- Gateway Patterns
300 Series Blueprints
- Product Management
- Design-Led
- Portals
- Syncing Your Specs with Collections
- Industry Interoperability
- Platforms
- Centralization
- Operational Interoperability
- Capability Collections
- World Building
- Governance
- Team Performance
- Gateway Testing
- Composable
- Schema Registry
- Organizing Your Standards
- High-Level API Governance
- Platform Capabilities
- Gateway Contracts
- Gateway Automation
- Gateway Upstream Protocols
- Gateway Downstream Protocols
- Gateway Extensibility
- Gateway Differentiators
- Category-Defining
400 Series Blueprints
- Complete
- Testing Landscape
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.