Example 1: API Architecture (OpenAPI) (+1)
Example 1: API Architecture (OpenAPI)
openapi: 3.0.0
info:
title: Authentication API
version: 1.0.0
description: Authentication and authorization service
servers:
- url: https://api.example.com/v1
description: Production
- url: https://staging-api.example.com/v1
description: Staging
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
apiKey:
type: apiKey
in: header
name: X-API-Key
schemas:
User:
type: object
properties:
id:
type: string
format: uuid
email:
type: string
format: email
roles:
type: array
items:
$ref: '#/components/schemas/Role'
Error:
type: object
required: [code, message]
properties:
code:
type: string
message:
type: string
details:
type: object
paths:
/auth/login:
post:
summary: User login
operationId: login
tags: [Authentication]
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [email, password]
properties:
email:
type: string
password:
type: string
responses:
200:
description: Successful login
content:
application/json:
schema:
type: object
properties:
token:
type: string
refreshToken:
type: string
user:
$ref: '#/components/schemas/User'
Example 2: Infrastructure Architecture (Kubernetes)
# Kubernetes Deployment Architecture
apiVersion: apps/v1
kind: Deployment
metadata:
name: auth-service
labels:
app: auth-service
spec:
replicas: 3
selector:
matchLabels:
app: auth-service
template:
metadata:
labels:
app: auth-service
spec:
containers:
- name: auth-service
image: auth-service:latest
ports:
- containerPort: 3000
env:
- name: NODE_ENV
value: "production"
- name: DATABASE_URL
valueFrom:
secretKeyRef:
name: db-secret
key: url
resources:
requests:
memory: "256Mi"
cpu: "250m"
limits:
memory: "512Mi"
cpu: "500m"
livenessProbe:
httpGet:
path: /health
port: 3000
initialDelaySeconds: 30
periodSeconds: 10
readinessProbe:
httpGet:
path: /ready
port: 3000
initialDelaySeconds: 5
periodSeconds: 5
---
apiVersion: v1
kind: Service
metadata:
name: auth-service
spec:
selector:
app: auth-service
ports:
- protocol: TCP
port: 80
targetPort: 3000
type: ClusterIP