Skip to content

DevOps Division Guidebook

Best practice for API design

Initializing search

Developer Hub Project

Home
Contact us
How-to
Tutorials
Explanations
Reference
Our Services

DevOps Division Guidebook

Developer Hub Project

Home
Contact us
Contact us
- Sending sensitive content
- This guidebook
How-to
How-to
- Products
  Products
  - Start developing a new product
  - Check product configuration
- Git/GitLab
  Git/GitLab
- Development
  Development
- GKE GitLab Runners
  GKE GitLab Runners
- Python
  Python
- Deployment
  Deployment
  - Synchronise 1password secrets to Google Cloud
- Cloud Platform
  Cloud Platform
  - Responding to billing alerts
  - Create Google Cloud Admin accounts
Tutorials
Tutorials
Explanations
Explanations
- Google Cloud admin accounts
- Service infrastructure and product factories
- Identifiers
- Webapp developer environment
- The Tech Lead Forum
- Cloud Platform
  Cloud Platform
  - Budgets and Alerts
- Git/GitLab
  Git/GitLab
- GKE GitLab Runners
- Python
  Python
  - How we use PyPI
Reference
Reference
- Other sources of documentation
- Well-known Identifier Scopes
- Local app development
- The Tech Lead Forum
- Git/GitLab
  Git/GitLab
- Best Practice
  Best Practice
- Cloud Platform
  Cloud Platform
- App Deployment
  App Deployment
- Working Environment
  Working Environment
  - Culture and Values
  - Meeting room locations
- Glossary
- Workflow
  Workflow
- Notes
  Notes
Our Services
Our Services
- Education
  Education
  - ADA for Disability Office
  - Digital Admissions
    Digital Admissions
    
    Digital Pooling
    
    My Cambridge Application
  - ESSM Sync
  - Events System
  - Exam Office exam time monitoring
  - Laboratory Allocation
    Laboratory Allocation
    
    Lab Allocator
    
    Legacy NST IA Lab Allocation
  - Lecture Capture
    Lecture Capture
    
    Lecture Capture Preferences App
    
    Panopto Deployment
  - Panel
  - Streaming Media Service
  - UTBS
  - Yuja Enterprise Video Platform
- HR Systems
  HR Systems
- Infrastructure and Generic Services
  Infrastructure and Generic Services
  - API Gateway
  - Design System
  - Equipment Sharing
  - GAOBase
  - GitLab
  - Governance
    Governance
    
    Governance
    
    Reporter
    
    Statutes and Ordinances
  - Identity and Access Management
    Identity and Access Management
    
    Card Management
    Card Management
    
    Card Management System
    
    Legacy Card System
    
    Network Tokens
    
    Google Workspace
    
    Google Workspace Preferences App
    
    Identity and Access Management
    
    Jackdaw
    
    Lookup
    
    Raven
    Raven
    
    Password Management
    
    Metadata
    
    OAuth2
    
    Webauth to SAML2
    
    SAML2
    
    Statistics API
    
    UCamWebAuth
    
    University Human Resources API
    
    University Student API
  - Information Asset Register
  - Nursery Waiting List
  - Regent House Ballots application
  - SCRIBE
  - Self-Service Gateway
  - Project Symphony
  - talks.cam
  - University Payment System
- Research
  Research
- Retired Services
  Retired Services

Best practice for API design¶

This section needs fleshing out.

GDS has a nice overview document on API design.

Made with Material for MkDocs